Update a shift

Updates an existing schedule shift record for a restaurant employee. A PUT request completely replaces the information in the existing record.

Securityoauth2
Request
path Parameters
shiftId
required
string <string>

The shift identifier, either the Toast platform GUID or an external identifier.

header Parameters
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 shift information. The externalId identifier is not allowed forPUT requests.

string
Responses
200

Returns the updated Shift.

400

The request contains data that is not supported by the current version of the API as described.

404

The GUID or external identifier does not match any shifts at the current restaurant.

415

The request did not have application/json in the Content-Type header.

500

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

put/shifts/{shiftId}
Request samples
application/json
{
  • "entityType": "Shift",
  • "jobReference": {
    },
  • "employeeReference": {
    },
  • "inDate": "2015-10-10T06:00:00.000+0000",
  • "outDate": "2015-10-10T12:00:00.000+0000"
}
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",
  • "deleted": true,
  • "jobReference": {
    },
  • "employeeReference": {
    },
  • "inDate": "2019-08-24T14:15:22Z",
  • "outDate": "2019-08-24T14:15:22Z",
  • "scheduleConfig": {
    }
}