DocumentationAPI Reference
API Reference

Create Shift

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

Creates a new shift in the specified schedule. While Open Shifts is enabled, a shift created as published must have at least one employee assigned or allow claiming.

OAuth Scopes: scheduling:shifts.write, time_tracking.write

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

Fields required to create a scheduling shift.

uuid
required

The ID of the schedule the shift belongs to.

The name of the shift.

enum
required

The status of the shift.

Allowed:
string
required
length between 6 and 6

6 character color hex code.

string
required

The timezone for the shift. Defaults to schedule timezone.

1 to 999

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

boolean
Defaults to false

Whether employees can claim this shift. A claimable shift must have a capacity: a request that would leave the shift claimable with a null capacity is rejected with a 422. Not gated by any release toggle.

Whether a claim on this shift requires manager approval. Defaults to the schedule's claimsRequireApprovalDefault when omitted.

employeeIds
array of integers
Defaults to []

What employees are assigned to this shift?

employeeIds
date-time
required

UTC timestamp of the start of the shift.

date-time
required

UTC timestamp of the end of the shift.

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

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

The UTC end time for a recurring shift.

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

Responses

Updated 6 months 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 6 months ago