v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB

Schedules

Update schedule 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.

patch/scheduling/v1/schedules/{schedule_id}/recurrence

Path parameters

schedule_idstring required

Unique identifier of the schedule to update.

Request body

effective_from'UPDATE_EFFECTIVE_FROM_UNSPECIFIED' | 'UPDATE_EFFECTIVE_FROM_CURRENT_OCCURRENCE' | 'UPDATE_EFFECTIVE_FROM_NEXT_OCCURRENCE' required

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.

Response

A successful response.

S12SchedulingV1UpdateScheduleRecurrenceResponse required

Response message for UpdateScheduleRecurrence.