---
title: "PATCH /api/im/schedules/{id}"
method: PATCH
path: "/api/im/schedules/{id}"
tags: ["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

- `id` string, required

## Request body

- object: Partial update; rotations, when given, replaces all rotation groups.
  - `name` string
  - `timezone` string: IANA zone, e.g. "Europe/Berlin".
  - `effectiveFrom` string, date-time, nullable
  - `effectiveUntil` string, date-time, nullable
  - `weeklySchedules` object[]: Empty or absent = around the clock.
    - `from` string, required
    - `until` union, required
      - string
      - '24:00'
    - `days` integer[], required
  - `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.
  - `customRepeatValue` integer, nullable: Required when rotationRepeats is custom.
  - `autoRotationSize` integer, nullable: Required when rotationMode is auto.
  - `roundRobinSize` integer
  - `startsOnDayOfWeek` integer, nullable: Required for weekly, biweekly and custom weeks rotations.
  - `startsOnDateOfMonth` integer, nullable: Required for monthly and custom months rotations.
  - `startsOnTime` string, nullable: Handover time; required unless rotationMode is none.
  - `rotations` object[]: Ordered rotation groups; every member must be a member of the team.
    - `members` string[], required

## Response `200`

Successful response

- object
  - `id` integer, required
  - `displayName` string, required
  - `timezone` string, required
  - `effectiveFrom` string, date-time, nullable, required
  - `effectiveUntil` string, date-time, nullable, required
  - `weeklySchedules` object[], required
    - `from` string, required
    - `until` union, required
      - string
      - '24:00'
    - `days` integer[], 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.
  - `customRepeatValue` integer, nullable, required: Required when rotationRepeats is custom.
  - `autoRotationSize` integer, nullable, required: Required when rotationMode is auto.
  - `roundRobinSize` integer, required
  - `startsOnDayOfWeek` integer, nullable, required: Required for weekly, biweekly and custom weeks rotations.
  - `startsOnDateOfMonth` integer, nullable, required: Required for monthly and custom months rotations.
  - `startsOnTime` string, nullable, required: Handover time; required unless rotationMode is none.
  - `rotations` object[], required
    - `id` integer, required
    - `rotationOrder` integer, required
    - `members` object[], required
      - `userId` string, required
      - `userName` string, nullable, required
      - `memberOrder` integer, required

## Other responses

- `400`: Invalid or missing parameters.
- `401`: Missing, invalid or expired API token.
- `404`: No such resource, or not visible to this token.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api.md) · [All operations](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/revisions/2129a771ee7e?raw)