Delete a shift

Marks an existing schedule shift record for a restaurant employee as deleted. If the shift record was already deleted, then the operation will succeed (HTTP 200 response code) and no change will be made.

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.

Responses
200

Returns the specified shift, with the deleted flag set to true.

400

The Toast platform GUID or external identifier was malformed.

404

The Toast platform GUID or external identifier does not match any shifts 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.

delete/shifts/{shiftId}
Request samples
curl -i -X DELETE \
  'https://toast-api-server/labor/v1/shifts/{shiftId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: string'
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": {
    }
}