Sign in

v1

latestOpenAPI 3.1.02026-07-24145580597.0 KB
Schedule:v1:Schedulers:Schedule:Shifts:Shifts

Create shifts

Create single or multiple shifts under a specific schedule

post/scheduler/v1/schedulers/{schedulerId}/shifts

Path parameters

schedulerIdinteger required

The unique identifier of the schedule

The unique identifier of the schedule

Query parameters

notifyUsersboolean nullable

Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published.

Indicates whether to send a notification to the users assigned to the shifts. This applies only to shifts that are published.

Request body

startTimeinteger required

The start time of the shift in Unix format (in seconds)

endTimeinteger required

The end time of the shift in Unix format (in seconds)

isOpenShiftboolean

Indicates whether the shift is an open shift. Creates only with 1 open spot

openSpotsinteger nullable

Integer with minimum value of 0

timezonestring nullable

The timezone of the shift in Tz format (e.g. America/New_York). If not specified, it uses the timezone configured in the app settings

titlestring nullable

The title of the shift, If this field remains empty, the jobId field must be specified.

isPublishedboolean

Indicates whether the shift is published

jobIdstring nullable

The ID of the associated job

isRequireAdminApprovalboolean nullable

Indicates whether admin approval is required for claiming the shift. Can only be set if the shift is an open shift

assignedUserIdsinteger[]

The list of assigned user IDs for the shift. When vision is enabled, multiple user IDs can be specified. Otherwise, only one user ID can be specified. If the shift is open, this list should remain empty.

colorstring nullable

The color associated with the shift, defaults to the color of the job linked to the shift. If a specific color is provided, it will override the default job color. Defaults to #4B7AC5. Should be one of the following colors: ['#4B7AC5', '#801A1A', '#AE2121', '#DC7A7A', '#B0712E', '#D4985A', '#E4B37F', '#AE8E2D', '#CBA73A', '#D9B443', '#487037', '#6F9B5C', '#91B282', '#365C64', '#5687B3', '#7C9BA2', '#3968BB', '#85A6DA', '#225A8C', '#548CBE', '#81A8CC', '#4E3F75', '#604E8E', '#8679AA', '#983D73', '#A43778', '#D178AD', '#6B2E4C', '#925071', '#B57D9A', '#3a3a3a', '#616161', '#969696']

Response

Successful Response

requestIdstring