Pricing Templates

POST /schedules/preview

Preview what an on-call schedule would look like without saving it.

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

For more information see the API Concepts Document

Scoped OAuth requires: schedules.write

Servers

https://api.pagerduty.com

Request headers

Name Type Required Description

Name	Type	Required	Description
`Accept`	String	Yes	The `Accept` header is used as a versioning header. Default value: "application/vnd.pagerduty+json;version=2"
`Content-Type`	String	Yes	Possible values: `"application/json"` Default value: "application/json"

Accept

String

Yes

The Accept header is used as a versioning header.

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

Content-Type

String

Yes

Possible values:

"application/json"

Default value: "application/json"

Query parameters

Name Type Required Description

Name	Type	Required	Description
`overflow`	Boolean	No	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`. Default value: false
`until`	String	No	The end of the date range over which you want to search.
`since`	String	No	The start of the date range over which you want to search.

overflow

Boolean

No

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.

Default value: false

until

String

No

The end of the date range over which you want to search.

since

String

No

The start of the date range over which you want to search.

Request body fields

Name	Type	Required	Description
`schedule`		Yes

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.

All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.

Pricing Templates Integrations Blog Contact Us Help

Terms of Service Privacy Policy