latestOpenAPI 3.0.22026-07-144652931.4 MB
b679a8f3f02c
Schedules_v3
Create 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:
- Update your automations to use the V3 API for all new shift-based schedules
- 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 on-call schedule with basic metadata. Rotations and events must be added via separate API calls after creation.
Rejected fields: rotations and escalation_policies are not accepted in the request body and will result in a 400 error.
post/v3/schedules
Request body
Example request
{
"schedule": {
"name": "Engineering On-Call",
"time_zone": "America/New_York",
"description": "Primary engineering on-call rotation"
}
}Response
Schedule created successfully
ScheduleResponse required— unresolved $ref