ALallquiet
OnCallOverrideResource

Update an on-call override

Updates an existing on-call override identified by ID.

Required API key permissions

  • Scope: on-call-overrides:update
  • Accepted key types: organization API key (org-wide), organization API key (team-scoped), personal access token (org-wide), personal access token (team-scoped)
  • Access: Access is checked against the specific resource (team or organization reachability).
  • Required team role (user-linked keys only): Administrator
  • Organization API keys are not subject to organization or team role checks.
  • Notes: Personal access tokens may manage overrides they are involved in (as the user or a replacement) with team access alone; managing other users' overrides requires team Administrator of the override's team, or of a shared team for all-teams overrides.
put/api/public/v1/on-call-override/{id}

Request

Path parameters

idstring uuid required

Query parameters

provisionboolean

When true, the created or updated resource is marked as provisioned and becomes read-only in the web UI. Defaults to false on create. On update, omitting this parameter preserves the existing provisioned state. Not available for personal access tokens.

Request body

userIdstring uuid required
teamIdstring uuid nullable
escalationTierinteger nullable
replacementUserIdsstring[] nullable
startstring date-time nullable
endstring date-time nullable
typestring required

Response

OK

idstring uuid
userIdstring uuid
teamIdstring uuid nullable
replacementUserIdsstring[] nullable
typestring nullable
startstring date-time nullable
endstring date-time nullable
isProvisionedboolean

Changes

No recorded changes to this operation across all 1 revision of this API.