<- Labor API

Labor API

All versions ->

Update scheduled shiftBeta

PUT

 /v2/labor/scheduled-shifts/{id}

Updates the draft shift details for a scheduled shift.

This endpoint supports sparse updates, so only new, changed, or removed fields are required in the request. You must publish the shift to make updates public.

You can make the following updates to draft_shift_details:

  • Change the location_id, job_id, start_at, and end_at fields.
  • Add, change, or clear the team_member_id and notes fields. To clear these fields, set the value to null.
  • Change the is_deleted field. To delete a scheduled shift, set is_deleted to true and then publish the shift.
Permissions:TIMECARDS_WRITE

Guide

Scheduling with the Labor API

Try in API Explorer
Link to section

Path parameters

Example code

Link to section

id

string

Required

The ID of the scheduled shift to update.

Link to section

Request body

Link to section

scheduled_shift

Required

The scheduled shift with any updates in the draft_shift_details field. If needed, call ListLocations to get location IDs, ListJobs to get job IDs, and SearchTeamMembers to get team member IDs and current job assignments. Updates made to published_shift_details are ignored.

If provided, the start_at and end_at timestamps must be 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

To enable optimistic concurrency control for the request, provide the current version of the shift in the version field. If the provided version doesn't match the server version, the request fails. If version is omitted, Square executes a blind write, potentially overwriting data from another publish request.

Link to section

Response fields

Link to section

scheduled_shift

Link to section

errors

Any errors that occurred during the request.