Update an event
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 an existing event.
Restrictions based on event timing:
- Past events (effective_until in the past): Cannot be modified
- Active events (currently producing shifts): Can only update
effective_until - Future events (effective_since in the future): All fields can be updated
Authorization
api_key The API Key with format Token token=<API_KEY>
In: header
Path Parameters
The ID of the schedule.
The ID of the rotation.
The ID of the event.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
The request replaces the full event. Send every required field,
even the fields that do not change. Get the current values with
GET /v3/schedules/{id}/rotations/{rotation_id}/events/{event_id}.
Which fields can be changed depends on the event's current state:
- Active events (already started): only
effective_untilcan be changed - Future events: all fields can be changed
- Past events: no fields can be changed (returns 400)
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
Developer Agreement
Your access to and use of the PagerDuty Developer Services is governed by the PagerDuty Developer Agreement.