Update a schedule

Update an existing on-call schedule.

A Schedule determines the time periods that users are On-Call.

For more information see the API Concepts Document

Scoped OAuth requires: schedules.write

Authorization

api_key

Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from 2011-06-01T10:00:00Z to 2011-06-01T14:00:00Z:

If you don't pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T10:00:00Z and end of 2011-06-01T14:00:00Z.
If you do pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T00:00:00Z and end of 2011-06-02T00:00:00Z.

Defaultfalse

Header Parameters

Accept*string

The Accept header is used as a versioning header.

Default"application/vnd.pagerduty+json;version=2"

Content-Type*"application/json"

Default"application/json"

Value in

"application/json"

Request Body

application/json

The schedule to be updated.

TypeScript Definitions

Use the request body type in TypeScript.

schedule*

Response Body

`application/json`

curl -X PUT "https://example.com/schedules/{id}" \  -H "Accept: application/vnd.pagerduty+json;version=2" \  -H "Content-Type: application/json" \  -H "Content-Type: application/json" \  -d '{    "schedule": {      "name": "Daily Engineering Rotation",      "type": "schedule",      "time_zone": "America/New_York",      "description": "Rotation schedule for engineering",      "schedule_layers": [        {          "name": "Night Shift",          "start": "2015-11-06T20:00:00-05:00",          "end": "2016-11-06T20:00:00-05:00",          "rotation_virtual_start": "2015-11-06T20:00:00-05:00",          "rotation_turn_length_seconds": 86400,          "users": [            {              "user": {                "id": "PXPGF42",                "type": "user_reference"              }            }          ],          "restrictions": [            {              "type": "daily_restriction",              "start_time_of_day": "08:00:00",              "duration_seconds": 32400            }          ]        }      ]    }  }'

{  "schedule": {    "id": "PI7DH85",    "type": "schedule",    "summary": "Daily Engineering Rotation",    "self": "https://api.pagerduty.com/schedules/PI7DH85",    "html_url": "https://subdomain.pagerduty.com/schedules/PI7DH85",    "name": "Daily Engineering Rotation",    "time_zone": "America/New_York",    "description": "Rotation schedule for engineering",    "escalation_policies": [      {        "id": "PT20YPA",        "type": "escalation_policy_reference",        "summary": "Another Escalation Policy",        "self": "https://api.pagerduty.com/escalation_policies/PT20YPA",        "html_url": "https://subdomain.pagerduty.com/escalation_policies/PT20YPA"      }    ],    "users": [      {        "id": "PXPGF42",        "type": "user_reference",        "summary": "Regina Phalange",        "self": "https://api.pagerduty.com/users/PXPGF42",        "html_url": "https://subdomain.pagerduty.com/users/PXPGF42"      }    ],    "teams": [      {        "id": "PQ9K7I8",        "type": "team_reference",        "summary": "Engineering",        "self": "https://api.pagerduty.com/teams/PQ9K7I8",        "html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8"      }    ],    "schedule_layers": [      {        "name": "Layer 1",        "rendered_schedule_entries": [],        "id": "PG68P1M",        "start": "2015-11-06T20:00:00-05:00",        "rotation_virtual_start": "2015-11-06T20:00:00-05:00",        "rotation_turn_length_seconds": 86400,        "users": [          {            "user": {              "id": "PXPGF42",              "type": "user_reference",              "summary": "Regina Phalange",              "self": "https://api.pagerduty.com/users/PXPGF42",              "html_url": "https://subdomain.pagerduty.com/users/PXPGF42"            }          }        ],        "restrictions": [          {            "type": "daily_restriction",            "start_time_of_day": "08:00:00",            "duration_seconds": 32400          }        ]      }    ],    "overrides_subschedule": {      "name": "Overrides",      "rendered_schedule_entries": []    },    "final_schedule": {      "name": "Final Schedule",      "rendered_schedule_entries": []    }  }}

Update a schedule

Authorization

Path Parameters

Query Parameters

Header Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Update a schedule

Authorization

Path Parameters

Query Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`