latestOpenAPI 3.0.22026-07-144652931.4 MB

b679a8f3f02c

Schedules_v3

Update a schedule

<!-- theme: info -->

Important note: Shift-based schedules use the V3 API and are not compatible with V2 automations. To create automations for Shift-Based Schedules, you need to:

  1. Update your automations to use the V3 API for all new shift-based schedules
  2. Keep the V2 endpoint for your existing schedules

An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. Learn more.

Update schedule metadata (name, description, time zone). All fields are optional — only provided fields are updated.

To modify rotations or events, use their respective endpoints.

Rejected fields: rotations and escalation_policies are not accepted and will result in a 400 error.

put/v3/schedules/{id}

Path parameters

idstring required

The ID of the schedule.

Request body

Example request

{
  "schedule": {
    "name": "Updated Schedule Name",
    "time_zone": "America/Los_Angeles",
    "description": "Updated description"
  }
}

Response

Schedule updated successfully

ScheduleResponse required— unresolved $ref