Update employee information

Updates the first name, chosen name, last name, external employee ID, and/or passcode of a restaurant employee. The PATCH operation cannot update any other employee information.

Securityoauth2
Request
path Parameters
employeeId
required
string

The Toast platform GUID or external identifier for the employee to be returned.

header Parameters
Content-Type
required
string <string>

The Internet Assigned Numbers Authority (IANA) media type of the message body data. The value must be application/json.

Toast-Restaurant-External-ID
required
string <string>

The Toast platform GUID of the restaurant that is the context for this operation.

Request Body schema: application/json

A JSON object containing the employee information that you are updating. You can update an employee's:

  • firstName - First name.

  • chosenName - Chosen name.

  • lastName - Last name.

  • externalEmployeeId - External employee identifier.

  • passcode - The passcode for access to Toast POS devices.

All values are optional. You must include at least one value. Each value that you include must contain information (not null). If you include the passcode value to update an employee's passcode you must include the employee's current passcode in the currentPasscode value.

string
Responses
200

Returns the updated Toast platform employee record.

400

The Toast platform GUID or external identifier was malformed, or the body of the request was malformed.

404

The Toast platform GUID or external identifier does not match any employees at the current restaurant.

500

An unexpected internal error occurred. There is a requestId attached to this error that can be referenced by Toast support.

patch/employees/{employeeId}
Request samples
application/json
{
  • "firstName": "Mynewfirstname",
  • "chosenName": "Mynewchosenname",
  • "lastName": "Mynewlastname",
  • "externalEmployeeId": "1234567890",
  • "passcode": "1234",
  • "currentPasscode": "1111"
}
Response samples
application/json
{
  • "guid": "string",
  • "entityType": "string",
  • "externalId": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "deletedDate": "2019-08-24T14:15:22Z",
  • "firstName": "string",
  • "chosenName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "phoneNumberCountryCode": "string",
  • "passcode": "string",
  • "externalEmployeeId": "string",
  • "deleted": true,
  • "jobReferences": [
    ],
  • "wageOverrides": [
    ],
  • "v2EmployeeGuid": "string"
}