|docs
Start Trial

Create a rotation

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 a new empty rotation for a schedule. After creating a rotation, add events to define the on-call pattern.

Note: Rotations have no configuration of their own — all scheduling logic (recurrence, assignment strategy, members) is specified on events. The request body must be empty or {}.

Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Path Parameters

id*string

The ID of the schedule.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Empty body — rotations carry no configuration at creation time

Response Body

application/json

application/json

application/json

application/json

application/json

application/json