Sign in
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

Changes

Changed in 2 of the 9 revisions of this API.3

  • e758bb1836951See the full diff
    • ○

      api operation id update-scheduler was added

      api-operation-id-added

  • 7bfe58df4d982See the full diff
    • ○

      added the new optional request property channels

      new-optional-request-property

    • ○

      added the required property data/allOf[Scheduler]/channels to the response with the 200 status

      response-required-property-added