Create Recurrence

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

Query Params

shift_id

Optional shift to delete before creating the recurrence

Body Params

The ID of the recurrence

name

Human-readable name for the recurrence

dtstart

Start date of the recurrence (RFC 5545 DTSTART)

freq

string

required

Frequency: DAILY, WEEKLY, MONTHLY, etc.

interval

integer

Defaults to 1

How often the rule repeats

count

Number of occurrences

until

End date

tzid

Timezone identifier

byday

array | null

Days of week (MO, TU, WE, etc.)

bymonthday

array | null

Days of month

bymonth

array | null

Months

exdate

array | null

Per-date shifts to exclude

activities_exdate

object | null

Per-date activities to exclude: {"YYYY-MM-DD": {"activities": [{"uuid": "...", "activity_type_id": 1}]}}

pattern_overrides

object | null

Monthly pattern overrides: {week_of_month: {DAY: <entry|[entry,...]>}} where entry = {start_time, end_time, activities}; a list lets a single weekday produce multiple shifts

assignments

array | null

Per-person date windows for which this recurrence applies

removed_person_range_ids

array | null

(Update only) IDs of RecurrencePersonRange rows to remove from this recurrence; their generated shifts are also deleted

reference_shift_id

The ID of the shift that this recurrence is derived from

original_recurrence_id

The ID of the original recurrence that this recurrence is derived from

reference_activity_id

The ID of the activity that this recurrence is derived from

next_recurrence_id

When this recurrence is split, points to the next recurrence in the split chain

200Successful Response

422Validation Error