API

Update schedule recurrence

patch
https://api.safetyculture.io/scheduling/v1/schedules//recurrence

Updates the recurrence configuration for a schedule, including the recurrence pattern, duration, timezone, and late submission rule. All recurrence fields are replaced with the provided values. Use effective_from to control whether changes apply from the current or next occurrence.

Path Params
string
required

Unique identifier of the schedule to update.

Body Params

UpdateScheduleRecurrence replaces the recurrence configuration for an existing schedule.

recurrence
object
required

ScheduleRecurrence defines when and how often the schedule repeats.

RFC 5545 recurrence definition combining DTSTART and RRULE properties. DTSTART specifies the start time and timezone. RRULE defines the recurrence pattern. Timezone defaults to UTC if unspecified, or if use_site_timezone is true.

Expected format: "DTSTART;TZID=America/New_York:20240101T140000\nRRULE:FREQ=DAILY;INTERVAL=1"

string
enum
required
Defaults to UPDATE_EFFECTIVE_FROM_UNSPECIFIED

UpdateEffectiveFrom specifies when schedule changes should take effect.

  • UPDATE_EFFECTIVE_FROM_UNSPECIFIED: Unspecified.
  • UPDATE_EFFECTIVE_FROM_CURRENT_OCCURRENCE: Apply changes starting from the current occurrence.
  • UPDATE_EFFECTIVE_FROM_NEXT_OCCURRENCE: Apply changes starting from the next occurrence.
Allowed:
Responses

Updated 1 day ago

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

Updated 1 day ago