Add an external identifier

Adds an external identifier for an existing employee. Include the string value of the new external identifier in the message body.

You cannot change an existing external identifier with another POST request; use PUT instead. The Toast platform uses this external identifier as one of the unique, persistent identifiers for an employee record.

Securityoauth2
Request
path Parameters
employeeId
required
string

The Toast platform GUID of the employee record.

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

The JSON string value of the externalId for the employee record. Wrap the value in double quotation marks to make it valid JSON syntax.

string
Responses
200

Returns the updated employee record.

post/employees/{employeeId}/externalId
Request samples
application/json
"MyToastNamingAuthority:9876543210"
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"
}