Create a schedule

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.

Authorization

api_key

Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

schedule*

Response Body

`application/json`

curl -X POST "https://api.pagerduty.com/v3/schedules" \  -H "Content-Type: application/json" \  -d '{    "schedule": {      "name": "Engineering On-Call",      "time_zone": "America/New_York"    }  }'

{  "schedule": {    "id": "PL5FQHC",    "type": "schedule_v3",    "name": "Engineering On-Call",    "time_zone": "America/New_York",    "description": "Primary engineering on-call rotation",    "teams": [      {        "id": "string",        "summary": "string",        "self": "string",        "html_url": "string",        "type": "team_reference"      }    ],    "escalation_policies": [      {        "id": "string",        "summary": "string",        "self": "string",        "html_url": "string",        "type": "escalation_policy_reference"      }    ],    "users": [      {        "id": "string",        "summary": "string",        "self": "string",        "html_url": "string",        "type": "user_reference"      }    ],    "rotations": [      {        "id": "ABCDEFGHIJKLMNOPQRSTUVWXY2",        "type": "schedule_rotation",        "events": [          {            "id": "ABCDEFGHIJKLMNOPQRSTUVWXY2",            "type": "schedule_event",            "name": "Weekly On-Call",            "start_time": {              "date_time": "2025-03-03T09:00:00Z",              "time_zone": "America/New_York"            },            "end_time": {              "date_time": "2025-03-03T09:00:00Z",              "time_zone": "America/New_York"            },            "effective_since": "2025-03-03T00:00:00Z",            "effective_until": "2025-09-01T00:00:00Z",            "recurrence": [              "RRULE:FREQ=WEEKLY"            ],            "assignment_strategy": {              "type": "rotating_member_assignment_strategy",              "shifts_per_member": 1,              "members": [                {                  "type": "user_member",                  "user_id": "PUSER123"                }              ]            },            "self": "http://example.com",            "html_url": "http://example.com"          }        ],        "self": "http://example.com",        "html_url": "http://example.com"      }    ],    "final_schedule": {      "type": "final_schedule",      "rendered_coverage_percentage": 100,      "computed_shift_assignments": [        {          "type": "computed_shift_assignment",          "start_time": "2025-01-06T09:00:00Z",          "end_time": "2025-01-13T09:00:00Z",          "member": {            "type": "user_member",            "user_id": "PUSER123"          },          "source": {            "type": "schedule_rotation",            "rotation_id": "ABCDEFGHIJKLMNOPQRSTUVWXY2",            "shift_id": "string",            "override_id": "string"          }        }      ]    },    "http_cal_url": "http://example.com",    "web_cal_url": "http://example.com",    "self": "http://example.com",    "html_url": "http://example.com"  }}

Create a schedule

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`