Create Shift Pattern

A schedule can contain many shift patterns. Collectively they determine the times that the
service/person/resource associated with the schedule, is available.
Each shift pattern has start and end times, indicating a shift of available time.
Shift patterns can be one-off or recurring regularly. If they are recurring the frequency
attribute is set to either 'daily' or 'weekly'. If recurring on a weekly basis the by_day
attribute indicates which days of the week the shifts will occur on.
The except_date attribute is an array of dates that shifts will not occur on, cancelling out
the recurrence pattern for that date.
The end of the shift pattern is indicated by either the end_date or repeat_count (the number
of days or weeks the pattern runs for).

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Company ID

int32
required

Schedule ID

Body Params
date

Start Date - in ISO-8601 %Y-%m-%d

date

End Date - in ISO-8601 %Y-%m-%d

string
required

Start Time - in ISO-8601 %H:%M

string
required

End Time - in ISO-8601 %H:%M

string
Defaults to daily

Frequency - How often the shifts occur. Either 'daily' or 'weekly'

int32
Defaults to 1

Interval - The duration between shift occurences as a multiple of frequency

int32

Repeat Count - The number of shift occurrences

array of strings

By Day - The days of the week a weekly shift pattern occurs on

by_day
array of strings

Except Date - List of dates where the shift pattern does not apply

except_date
int32
array of dates
dates
Responses

400

Bad Request

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