Skip to main content
API Explorer|API Explorer
Alerting & Response/On-Call
PUTOnCallSince 1.0SynchronousAuth Required

UpdateEscalationPolicy

Update an existing escalation policy's rules or configuration

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • policyIdStringRequired

    ID of the escalation policy to update

Body Fields

  • nameStringRequired

    Updated name for the escalation policy

    Example: my-resource

  • descriptionStringRequired

    Updated description for the escalation policy

    Example: A brief description

  • rulesListRequired

    Updated ordered list of escalation rules

    Example: (nested array)

    • levelInteger

      Escalation level number (starting from 1)

      Example: 1

    • targetsList

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

      Example: item1,item2

    • timeoutString

      Duration to wait before escalating to the next level

      Example: 15m

    • notifyMethodsList

      Notification channels used at this escalation level

      Example: item1,item2

  • repeatCountIntegerRequired

    Updated repeat count for the escalation cycle

    Example: 10

Responses

200 OK

On success, this API returns the following response structure.

  • uuidString

    Unique identifier of the escalation policy

    Example: pol-11223344

  • nameString

    Human-readable name of the escalation policy

    Example: Critical Alert Policy

  • descriptionString

    Description of when this escalation policy is used

    Example: Escalation policy for P0 incidents

  • rulesList

    Ordered list of escalation rules in this policy

    Example: (nested array)

    • levelInteger

      Escalation level number (starting from 1)

      Example: 1

    • targetsList

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

      Example: item1,item2

    • timeoutString

      Duration to wait before escalating to the next level

      Example: 15m

    • notifyMethodsList

      Notification channels used at this escalation level

      Example: item1,item2

  • repeatCountInteger

    Number of times to repeat the full escalation cycle if unacknowledged

    Example: 3

  • createDateString

    Timestamp when the escalation policy was created

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

  • lastOpDateString

    Timestamp of the last modification to the escalation policy

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

Endpoint

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

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

Operation ID

UpdateEscalationPolicy

Permalink

Request Example

curl -X PUT '{host}/api/v1/oncall/escalation-policies/{policyId}' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"name":"my-resource","description":"A brief description","rules":"(nested array)","repeatCount":10}'

Response Example

200
{
  "uuid": "pol-11223344",
  "name": "Critical Alert Policy",
  "description": "Escalation policy for P0 incidents",
  "rules": [
    {}
  ],
  "repeatCount": 3,
  "createDate": "example",
  "lastOpDate": "example"
}

Change History

This API has no change history records yet.

View all change history