Im

PATCH /api/im/schedules/{id}

patch/api/im/schedules/{id}

Request

  • Base URL: https://uptimeify.io
  • URL: https://uptimeify.io/api/im/schedules/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

namestring
timezonestring

IANA zone, e.g. "Europe/Berlin".

effectiveFromstring date-time nullable
effectiveUntilstring date-time nullable
rotationMode'none' | 'auto' | 'explicit'

Default none. auto/explicit require rotationRepeats and startsOnTime.

rotationRepeats'daily' | 'weekly' | 'biweekly' | 'monthly' | 'custom' nullable

Required unless rotationMode is none (then it must be null).

customRepeatUnit'minutes' | 'hours' | 'days' | 'weeks' | 'months' nullable

Required when rotationRepeats is custom.

customRepeatValueinteger nullable

Required when rotationRepeats is custom.

autoRotationSizeinteger nullable

Required when rotationMode is auto.

roundRobinSizeinteger
startsOnDayOfWeekinteger nullable

Required for weekly, biweekly and custom weeks rotations.

startsOnDateOfMonthinteger nullable

Required for monthly and custom months rotations.

startsOnTimestring nullable

Handover time; required unless rotationMode is none.

Response

Successful response

idinteger required
displayNamestring required
timezonestring required
effectiveFromstring date-time nullable required
effectiveUntilstring date-time nullable required
rotationMode'none' | 'auto' | 'explicit' required

Default none. auto/explicit require rotationRepeats and startsOnTime.

rotationRepeats'daily' | 'weekly' | 'biweekly' | 'monthly' | 'custom' nullable required

Required unless rotationMode is none (then it must be null).

customRepeatUnit'minutes' | 'hours' | 'days' | 'weeks' | 'months' nullable required

Required when rotationRepeats is custom.

customRepeatValueinteger nullable required

Required when rotationRepeats is custom.

autoRotationSizeinteger nullable required

Required when rotationMode is auto.

roundRobinSizeinteger required
startsOnDayOfWeekinteger nullable required

Required for weekly, biweekly and custom weeks rotations.

startsOnDateOfMonthinteger nullable required

Required for monthly and custom months rotations.

startsOnTimestring nullable required

Handover time; required unless rotationMode is none.

Changes

No recorded changes to this operation across all 1 revision of this API.