Create a shift

Creates a schedule shift for a restaurant employee.

Securityoauth2
Request
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

A Shift object containing information about the shift, including the job identifier, the employee identifier, and the start and end times.

string
Responses
200

Creates a shift record and returns information about it.

400

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

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.

post/shifts
Request samples
application/json
{
  • "externalId": "MyToastNamingAuthority:1234",
  • "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": {
    }
}