v3

latestOpenAPI 3.0.02026-07-318685204.9 KB
Schedulers

Update a scheduler by ID

patch/schedulers/{id}

Path parameters

idstring required

Scheduler ID

Scheduler ID

Request body

namestring

Name of the scheduler

startDatestring

Start date (YYYY-MM-DD)

startTimestring

Start time (HH:mm)

timeZonestring

IANA time zone (e.g. "UTC", "Europe/Brussels")

endDatestring nullable

End date (YYYY-MM-DD). Set to null to unset.

endTimestring nullable

End time (HH:mm). Set to null to unset.

recurrencestring nullable

RRULE recurrence string. Set to null to unset.

channelIdsstring[]

Channel IDs (deprecated, use channels instead). All engines of each channel are scheduled.

enabledboolean

Whether the scheduler is enabled

Response

Updated scheduler