v1

latestOpenAPI 3.0.22026-07-144652931.4 MB
Schedules_v3

Create custom shifts

<!-- 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 custom shifts for a schedule. Custom shifts are ad-hoc one-off coverage periods that exist outside of rotation events.

Each custom shift requires exactly one assignment.

post/v3/schedules/{id}/custom_shifts

Path parameters

idstring required

The ID of the schedule.

Request body

Example request

{
  "custom_shifts": [
    {
      "assignments": [
        {
          "member": {
            "user_id": "PUSER123"
          }
        }
      ]
    }
  ]
}

Response

Custom shifts created successfully

Example response

{
  "custom_shifts": [
    {
      "start_time": "2025-03-15T09:00:00Z",
      "end_time": "2025-03-15T17:00:00Z",
      "assignments": [
        {
          "member": {
            "user_id": "PUSER123"
          }
        }
      ]
    }
  ]
}