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

Update schedule metadata (name, description, time zone). time_zone is required; name and description are optional and keep their current values when omitted.

To modify rotations or events, use their respective endpoints.

Rejected fields: rotations and escalation_policies are not accepted and will result in a 400 error.

Authorization

api_key

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.

schedule*

time_zone is required. name and description are optional; an omitted field keeps its current value.

Response Body

`application/json`

curl -X PUT "https://api.pagerduty.com/v3/schedules/PSJUKNI" \  -H "Content-Type: application/json" \  -d '{    "schedule": {      "name": "New Schedule Name"    }  }'

{  "schedule": {    "id": "PS1A2B3C",    "type": "schedule_v3",    "name": "Updated Schedule",    "time_zone": "America/Los_Angeles",    "self": "https://api.pagerduty.com/v3/schedules/PS1A2B3C"  }}

Update a schedule

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

Developer Agreement

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`