> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update 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](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#schedules).

<Note>
  External Documentation

  To learn more, visit the [PagerDuty documentation](https://developer.pagerduty.com/api-reference/7aff39ee95bfc-update-a-schedule).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter            | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
  | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Schedule Description | The description of the schedule.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
  | Schedule ID          | The ID of the schedule to update.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
  | Schedule Layers      | A list of schedule layers.<br />An array of schedule layers containing the following format:<br />- `id`: <br />- `start`:<br />  This field is required.<br />- `end`:<br />   The end time of this layer. If null, the layer does not end.<br />- `users`<br />  The ordered list of users on this layer. The position of the user on the list determines their order in the layer.<br />  This field is required.<br />- `restrictions`:<br />  An array of restrictions for the layer. A restriction is a limit on which period of the day or week the schedule layer can accept assignments. Restrictions respect the time\_zone parameter of the request.<br />- `rotation_virtual_start`:<br />  The effective start time of the layer. This can be before the start time of the schedule.<br />  This field is required.<br />- `rotation_turn_length_seconds`:<br />   The duration of each on-call shift in seconds.<br />  This field is required.<br />- `name`:<br />  The name of the schedule layer. |
  | Schedule Name        | The name of the schedule.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
  | Schedule Time Zone   | The time zone of the schedule.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter                                          | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
  | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
  | Final Schedule Name                                | The name of the subschedule.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
  | Final Schedule Rendered Coverage Percentage        | The percentage of the time range covered by this layer. Returns null unless since or until are set.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
  | Final Schedule Rendered Schedule Entries           | This is a list of entries on the computed layer for the current time range. Since or until must be set in order for this field to be populated.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
  | Overflow                                           | 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.<br />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`:<br /><br /><br />- 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`.<br />- 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`. |
  | Overrides Subschedule Name                         | The name of the subschedule.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
  | Overrides Subschedule Rendered Coverage Percentage | The percentage of the time range covered by this layer. Returns null unless since or until are set.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
  | Overrides Subschedule Rendered Schedule Entries    | This is a list of entries on the computed layer for the current time range. Since or until must be set in order for this field to be populated.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
</div>

## Example Output

```json theme={"dark"}
{
	"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": []
		}
	}
}
```

## Workflow Library Example

[Update Schedule with Pagerduty and Send Results Via Email](https://library.blinkops.com/workflows/update-schedule-with-pagerduty-and-send-results-via-email)

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/update-schedule-with-pagerduty-and-send-results-via-email/canvas" />
</div>
