Replace a jobs list

Replaces the list of jobs for an employee. Include a JSON
array of job identifiers in the message body.

If a job is defined at the restaurant group or subgroup level, this operation adds or removes that job for the the employee at all restaurant locations in the group or subgroup.

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

An array of JSON objects containing identifiers for jobs. The identifiers can be either Toast platform GUIDs or external identifiers.

string
Responses
200

Returns the updated employee record.

put/employees/{employeeId}/jobs
Request samples
application/json
[
  • {
    },
  • {
    }
]
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"
}