Skip to main content
ZStack
Alerting & Response/On-Call

UpdateEscalationPolicy

Update an existing escalation policy's rules or configuration

PUT/api/v1/oncall/escalation-policies/{policyId}

Operation ID

UpdateEscalationPolicy

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Path Parameters

  • policyId
    StringRequired

    ID of the escalation policy to update

Body Fields

  • name
    StringRequired

    Updated name for the escalation policy

    Example: my-resource

  • description
    StringRequired

    Updated description for the escalation policy

    Example: A brief description

  • rules
    ListRequired

    Updated ordered list of escalation rules

    Example: (nested array)

    • level
      Integer

      Escalation level number (starting from 1)

      Example: 1

    • targets
      List

      List of user or group IDs to notify at this escalation level

      Example: item1,item2

    • timeout
      String

      Duration to wait before escalating to the next level

      Example: 15m

    • notifyMethods
      List

      Notification channels used at this escalation level

      Example: item1,item2

  • repeatCount
    IntegerRequired

    Updated repeat count for the escalation cycle

    Example: 10

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • uuid
    String

    Unique identifier of the escalation policy

    Example: pol-11223344

  • name
    String

    Human-readable name of the escalation policy

    Example: Critical Alert Policy

  • description
    String

    Description of when this escalation policy is used

    Example: Escalation policy for P0 incidents

  • rules
    List

    Ordered list of escalation rules in this policy

    Example: (nested array)

    • level
      Integer

      Escalation level number (starting from 1)

      Example: 1

    • targets
      List

      List of user or group IDs to notify at this escalation level

      Example: item1,item2

    • timeout
      String

      Duration to wait before escalating to the next level

      Example: 15m

    • notifyMethods
      List

      Notification channels used at this escalation level

      Example: item1,item2

  • repeatCount
    Integer

    Number of times to repeat the full escalation cycle if unacknowledged

    Example: 3

  • createDate
    String

    Timestamp when the escalation policy was created

    Example: 2026-01-15T08:00:00Z

  • lastOpDate
    String

    Timestamp of the last modification to the escalation policy

    Example: 2026-01-15T08:00:00Z