patch
https://api.mitti.com/scheduling/v1/schedules//recurrence
Updates the recurrence configuration for an existing schedule.
Update the recurrence configuration for an existing schedule. The new recurrence object replaces the current configuration entirely.
Use effective_from to control whether the change applies from the current occurrence or the next one.
Recurrence fields
| Field | Required | Description |
|---|---|---|
dtstart_rrule | Yes | RFC 5545 string combining DTSTART and RRULE. Defines the start time, timezone, and repeat pattern. Example: "DTSTART;TZID=America/New_York:20240101T140000\nRRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO" |
duration | Yes | ISO 8601 duration string defining the occurrence window length. Example: "PT1H" for one hour. |
use_site_timezone | No | When true, each target site's configured timezone is used instead of the timezone in the RRULE. Only applies to schedules with site or asset targets. |
late_submission_rule | No | Controls how long after an occurrence ends users can still submit work. Set until_next_occurrence to allow submission until the next occurrence starts, or late_submission_duration to allow a fixed window (currently only "P14D" is supported). |
Note: When
use_site_timezoneistrue, omit theTZIDparameter fromdtstart_rrule. The timezone is derived from each site in the schedule's targets and must not be set in the recurrence rule.
Effective from options
| Option | Description |
|---|---|
UPDATE_EFFECTIVE_FROM_CURRENT_OCCURRENCE | Apply the new recurrence from the current occurrence. |
UPDATE_EFFECTIVE_FROM_NEXT_OCCURRENCE | Apply the new recurrence from the next occurrence. |