v1

latestOpenAPI 3.0.22026-07-144652931.4 MB
Schedules_v3

Create overrides

<!-- 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.

Create one or more overrides for a schedule. An override temporarily replaces a scheduled on-call member with a different member for a specific time period.

Each override must reference either a rotation_id or a custom_shift_id (not both). The overriding member must belong to the account.

Note: The create response wraps the result in an overrides array. Single-resource endpoints (get, update) wrap in override (singular).

post/v3/schedules/{id}/overrides

Path parameters

idstring required

The ID of the schedule.

Request body

Example request

{
  "overrides": [
    {
      "overridden_member": {
        "user_id": "PUSER123"
      },
      "overriding_member": {
        "user_id": "PUSER123"
      }
    }
  ]
}

Response

Overrides created successfully

Example response

{
  "overrides": [
    {
      "rotation_id": "ABCDEFGHIJKLMNOPQRSTUVWXY2",
      "start_time": "2025-03-15T09:00:00Z",
      "end_time": "2025-03-15T17:00:00Z",
      "overridden_member": {
        "user_id": "PUSER123"
      },
      "overriding_member": {
        "user_id": "PUSER123"
      }
    }
  ]
}