DocumentationAPI Reference
API Reference

Update Shift

patch
https://{companyDomain}.bamboohr.com/api/v1/scheduling/shifts/

Updates a shift by its UUID. Fields not provided will retain their existing values. For published shifts, changes are not applied directly — they are stored as pending (unpublishedChanges) and take effect when the shift is published. recurrenceEditOption is required when the shift already has recurrence settings; ALL and FUTURE edits propagate to published sibling occurrences the same way, staging changes rather than applying them immediately. Sibling shifts may be permanently removed if they no longer conform to changed recurrence fields.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The shift uuid

Body Params

Fields for updating a scheduling shift. All fields are optional, and only provided fields will be updated. recurrenceEditOption is required when the shift already has recurrence settings.

string | null

The name of the shift

string
length between 6 and 6

6 character color hex code.

integer | null
≥ 1
Defaults to null

The expected headcount for the shift. If null, has no restrictions.

date-time

UTC timestamp of the start of the shift.

date-time

UTC timestamp of the end of the shift.

string

The timezone for the shift.

string | null

The recurrence rule. Follows the iCalendar RFC 5545 RRULE syntax.

string | null
enum

How should recurrence edits be effective? Edits will not affect any realized shifts regardless of option.

Allowed:
string | null

The UTC start time for a recurring shift and the anchor point for the recurrence rule.

string | null

The UTC end time for a recurring shift.

string | null

The UTC datetime when the recurrence series stops generating new occurrences (UNTIL in RRULE).

employeeIds
array of integers

What employees are assigned to this shift?

employeeIds
null

The pending changes that have not been published. Only accepts null to clear unpublished changes.

Responses

Updated 13 days ago

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 13 days ago