overrides

Creates, updates, deletes, gets or lists an overrides resource.

Overview

Name	overrides
Type	Resource
Id	pagerduty.schedules_v3.overrides

Fields

The following fields are returned by SELECT queries:

get

Override retrieved successfully

Name	Datatype	Description
id	string
custom_shift_id	string	ID of the custom shift being overridden (mutually exclusive with rotation_id)
rotation_id	string	ID of the rotation whose shift is being overridden (mutually exclusive with custom_shift_id) (example: ABCDEFGHIJKLMNOPQRSTUVWXY2)
end_time	string (date-time)	(example: 2025-03-15T17:00:00Z)
html_url	string (uri)
overridden_member	object	A member (user) assigned to a shift or rotation slot
overriding_member	object	A member (user) assigned to a shift or rotation slot
self	string (uri)
start_time	string (date-time)	(example: 2025-03-15T09:00:00Z)
type	string	(override_shift)

list

Overrides retrieved successfully

Name	Datatype	Description
id	string
custom_shift_id	string	ID of the custom shift being overridden (mutually exclusive with rotation_id)
rotation_id	string	ID of the rotation whose shift is being overridden (mutually exclusive with custom_shift_id) (example: ABCDEFGHIJKLMNOPQRSTUVWXY2)
end_time	string (date-time)	(example: 2025-03-15T17:00:00Z)
html_url	string (uri)
overridden_member	object	A member (user) assigned to a shift or rotation slot
overriding_member	object	A member (user) assigned to a shift or rotation slot
self	string (uri)
start_time	string (date-time)	(example: 2025-03-15T09:00:00Z)
type	string	(override_shift)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, override_id		<!-- theme: info --><br /><br />> 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:<br />><br />> 1. Update your automations to use the V3 API for all new shift-based schedules<br />> 2. Keep the V2 endpoint for your existing schedules<br />><br />> An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https:​//support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples).<br /><br />Retrieve a single override by ID.<br />
list	select	id, since, until	time_zone, overflow, limit, offset	<!-- theme: info --><br /><br />> 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:<br />><br />> 1. Update your automations to use the V3 API for all new shift-based schedules<br />> 2. Keep the V2 endpoint for your existing schedules<br />><br />> An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https:​//support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples).<br /><br />Retrieve overrides for a schedule within a time range.<br /><br />since and until are required.<br />
create	insert	id, overrides		<!-- theme: info --><br /><br />> 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:<br />><br />> 1. Update your automations to use the V3 API for all new shift-based schedules<br />> 2. Keep the V2 endpoint for your existing schedules<br />><br />> An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https:​//support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples).<br /><br />Create one or more overrides for a schedule. An override temporarily<br />replaces a scheduled on-call member with a different member for a<br />specific time period.<br /><br />Each override must reference either a rotation_id or a<br />custom_shift_id (not both). The overriding member must belong to<br />the account.<br /><br />Note: The create response wraps the result in an overrides array.<br />Single-resource endpoints (get, update) wrap in override (singular).<br />
update	update	id, override_id, override		<!-- theme: info --><br /><br />> 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:<br />><br />> 1. Update your automations to use the V3 API for all new shift-based schedules<br />> 2. Keep the V2 endpoint for your existing schedules<br />><br />> An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https:​//support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples).<br /><br />Update an existing override.<br />
delete	delete	id, override_id		<!-- theme: info --><br /><br />> 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:<br />><br />> 1. Update your automations to use the V3 API for all new shift-based schedules<br />> 2. Keep the V2 endpoint for your existing schedules<br />><br />> An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https:​//support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples).<br /><br />Delete an override by ID.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The ID of the schedule. (example: PSJUKNI)
override_id	string	The ID of the override. (example: AGO4642RBB5RBGG65Q6I5X34VI)
since	string (date-time)	Start of time range (ISO 8601) (example: 2026-06-01T00:00:00Z)
until	string (date-time)	End of time range (ISO 8601) (example: 2026-06-28T23:59:59Z)
limit	integer
offset	integer
overflow	boolean	Include shifts that extend beyond the requested time range boundaries
time_zone	string	IANA timezone identifier for rendering shift times. Defaults to the schedule's configured time zone. (example: America/New_York)

SELECT examples

get

<!-- theme: info --><br /><br />> 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:<br />><br />> 1. Update your automations to use the V3 API for all new shift-based schedules<br />> 2. Keep the V2 endpoint for your existing schedules<br />><br />> An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https:​//support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples).<br /><br />Retrieve a single override by ID.<br />

SELECT
id,
custom_shift_id,
rotation_id,
end_time,
html_url,
overridden_member,
overriding_member,
self,
start_time,
type
FROM pagerduty.schedules_v3.overrides
WHERE id = '{{ id }}' -- required
AND override_id = '{{ override_id }}' -- required
;

list

<!-- theme: info --><br /><br />> 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:<br />><br />> 1. Update your automations to use the V3 API for all new shift-based schedules<br />> 2. Keep the V2 endpoint for your existing schedules<br />><br />> An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https:​//support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples).<br /><br />Retrieve overrides for a schedule within a time range.<br /><br />since and until are required.<br />

SELECT
id,
custom_shift_id,
rotation_id,
end_time,
html_url,
overridden_member,
overriding_member,
self,
start_time,
type
FROM pagerduty.schedules_v3.overrides
WHERE id = '{{ id }}' -- required
AND since = '{{ since }}' -- required
AND until = '{{ until }}' -- required
AND time_zone = '{{ time_zone }}'
AND overflow = '{{ overflow }}'
AND limit = '{{ limit }}'
AND offset = '{{ offset }}'
;

INSERT examples

create

<!-- theme: info --><br /><br />> 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:<br />><br />> 1. Update your automations to use the V3 API for all new shift-based schedules<br />> 2. Keep the V2 endpoint for your existing schedules<br />><br />> An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https:​//support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples).<br /><br />Create one or more overrides for a schedule. An override temporarily<br />replaces a scheduled on-call member with a different member for a<br />specific time period.<br /><br />Each override must reference either a rotation_id or a<br />custom_shift_id (not both). The overriding member must belong to<br />the account.<br /><br />Note: The create response wraps the result in an overrides array.<br />Single-resource endpoints (get, update) wrap in override (singular).<br />

INSERT INTO pagerduty.schedules_v3.overrides (
overrides,
id
)
SELECT 
'{{ overrides }}' /* required */,
'{{ id }}'
RETURNING
overrides
;

Manifest

# Description fields are for documentation purposes
- name: overrides
props:
  - name: id
    value: "{{ id }}"
    description: Required parameter for the overrides resource.
  - name: overrides
    value:
      - type: "{{ type }}"
        rotation_id: "{{ rotation_id }}"
        custom_shift_id: "{{ custom_shift_id }}"
        start_time: "{{ start_time }}"
        end_time: "{{ end_time }}"
        overridden_member:
          type: "{{ type }}"
          user_id: "{{ user_id }}"
        overriding_member:
          type: "{{ type }}"
          user_id: "{{ user_id }}"

UPDATE examples

update

<!-- theme: info --><br /><br />> 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:<br />><br />> 1. Update your automations to use the V3 API for all new shift-based schedules<br />> 2. Keep the V2 endpoint for your existing schedules<br />><br />> An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https:​//support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples).<br /><br />Update an existing override.<br />

UPDATE pagerduty.schedules_v3.overrides
SET 
override = '{{ override }}'
WHERE 
id = '{{ id }}' --required
AND override_id = '{{ override_id }}' --required
AND override = '{{ override }}' --required
RETURNING
override;

DELETE examples

delete

<!-- theme: info --><br /><br />> 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:<br />><br />> 1. Update your automations to use the V3 API for all new shift-based schedules<br />> 2. Keep the V2 endpoint for your existing schedules<br />><br />> An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. [Learn more](https:​//support.pagerduty.com/main/docs/shift-based-schedules-api-upgrade-examples).<br /><br />Delete an override by ID.<br />

DELETE FROM pagerduty.schedules_v3.overrides
WHERE id = '{{ id }}' --required
AND override_id = '{{ override_id }}' --required
;