<- Labor API

Labor API

Create shift

POST

 /v2/labor/shifts

Creates a new Shift.

A Shift represents a complete workday for a single team member. You must provide the following values in your request to this endpoint:

  • location_id
  • team_member_id
  • start_at

An attempt to create a new Shift can result in a BAD_REQUEST error when:

  • The status of the new Shift is OPEN and the team member has another shift with an OPEN status.
  • The start_at date is in the future.
  • The start_at or end_at date overlaps another shift for the same team member.
  • The Break instances are set in the request and a break start_at is before the Shift.start_at, a break end_at is after the Shift.end_at, or both.
Permissions:TIMECARDS_WRITE
Try in API Explorer
Link to section

Request body

Example code

Link to section

idempotency_key

string

A unique string value to ensure the idempotency of the operation.

Max Length
128
Link to section

shift

Required

The Shift to be created.

Link to section

Response fields

Link to section

shift

The Shift that was created on the request.

Link to section

errors

Any errors that occurred during the request.