Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Slack and other integrations ↗
    3. Connecting external calendars
    4. Advanced guide
  4. Incidents
    1. Get started
    2. Post mortems
    3. Metadata & Catalog
    4. Screening alerts
    5. Reporting ↗
  5. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Uptime API
    1. Getting an API token
    2. Monitors
    3. Heartbeats
    4. On-call & incidents
      1. On-call schedule
      2. On-call schedule events
      3. On-call schedule rotations
      4. Escalation policies
        1. List escalation policies GET
        2. Get escalation policy GET
        3. Create escalation policy POST
        4. Update escalation policy PATCH
        5. Remove escalation policy DELETE
        6. Response attributes
      5. Escalation policy groups
      6. Severities
      7. Severity groups
      8. Incidents
      9. Comments
    5. Status pages
    6. Metadata
    7. Integrations
    8. Team members
    9. Reporting

Update escalation policy

Update an existing escalation policy. Send only the parameters you wish to change (eg. url).

PATCH https://uptime.betterstack.com/api/v3/policies/{policy_id}

URL parameters

policy_id
required integer

The ID of the escalation policy you want to update

Headers

Authorization
required string

Bearer $TOKEN

Content_Type
string

application/json

Body parameters

name
string

The name of this Policy.

repeat_count
integer

How long in seconds to wait before each repetition.

repeat_delay
integer

Incident token that can be used for manually reporting incidents.

steps
Array of PolicyStep

An array of escalation policy steps. See the list of escalation policy API parameters for details.

fallback_policy_id
integer

The ID of an escalation policy to escalate to once this policy has run all its steps and repeats without being acknowledged. Must belong to the same organization. Defaults to null (no further escalation).

200

Returns the updated escalation policy

Response body

{
  "data": {
    "id": "456",
    "type": "policy",
    "attributes": {
      "name": "Policy A",
      "repeat_count": 5,
      "repeat_delay": 0,
      "incident_token": "8nEiLj2gfqjfQRK6vzkFuGC25",
      "policy_group_id": null,
      "team_name": "Test team"
    },
    "steps": [
      {
        "type": "escalation",
        "wait_before": 0,
        "urgency_id": 12345,
        "step_members": [
          {
            "type": "all_slack_integrations"
          },
          {
            "type": "current_on_call"
          }
        ]
      }
    ]
  }
}

Example cURL

Example
curl -X "PATCH" "https://uptime.betterstack.com/api/v3/policies/456" \
-H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json; charset=utf-8' \
-d $'{ "name": "New name" }'


Previous article

Create escalation policy

Next article

Remove escalation policy