Escalation policies

Update an escalation policy

Replaces the name, the description and the whole step list. Steps are never merged: a list of steps is an order, so send the complete chain even when changing one step. Every notification setting pointing at this policy starts using the new chain on the next alert; chains already running keep the snapshot they started with. PATCH is accepted on the same path with identical semantics.

put/api/v1/escalation-policies/{escalation_policy}

Request

  • Base URL: https://wardenpoint.com (the document declares no server; this is the origin it was published from)
  • URL: https://wardenpoint.com/api/v1/escalation-policies/{escalation_policy}
  • Auth: API key in header X-API-Key

Path parameters

escalation_policystring uuid required

Policy UUID.

Request body

namestring required

Display name. Nothing stops two policies of a company sharing one, and this is the name that identifies the policy when a deletion is refused because it holds a recipient or a schedule — a second policy called "Night shift" makes that answer useless. Choose it as the label somebody will read under pressure.

descriptionstring nullable

Free text for people, never used to route anything. Omitting the field on an update leaves the stored text alone; sending an explicit null erases it. On create the two are indistinguishable.

Response

The updated policy.

Changes

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