Add or replace an external identifier

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

The Toast platform uses this external identifier as one of the unique, persistent identifiers for a job record. Changing the external identifier for an existing job might affect reporting and other Toast platform functions that select jobs using the externalId value.

Securityoauth2

Request

path Parameters

• jobId required:
  string

  The Toast platform GUID or external identifier of the job 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 job record. Wrap the value in double quotation marks to make it valid JSON syntax.

string

Responses

200

Returns the updated job record.

put /jobs/{jobId}/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",
  "title": "string",
  "deleted": true,
  "wageFrequency": "HOURLY",
  "defaultWage": 0,
  "tipped": true,
  "code": "string",
  "excludeFromReporting": true
}