<- Labor API

Labor API

All versions ->

Create scheduled shiftBeta

POST

 /v2/labor/scheduled-shifts

Creates a scheduled shift by providing draft shift details such as job ID, team member assignment, and start and end times.

The following draft_shift_details fields are required:

  • location_id
  • job_id
  • start_at
  • end_at
Permissions:TIMECARDS_WRITE
Try in API Explorer
Link to section

Request body

Example code

Link to section

idempotency_key

string

A unique identifier for the CreateScheduledShift request, used to ensure the idempotency of the operation.

Link to section

scheduled_shift

Required

The scheduled shift with draft_shift_details. If needed, call ListLocations to get location IDs, ListJobs to get job IDs, and SearchTeamMembers to get team member IDs and current job assignments.

The start_at and end_at timestamps must be provided in the time zone + offset of the shift location specified in location_id. Example for Pacific Standard Time: 2024-10-31T12:30:00-08:00

Link to section

Response fields

Link to section

scheduled_shift

Link to section

errors

Any errors that occurred during the request.