Update an escalation policy.

PUT

/escalation_policy/{policy_id}

curl --request PUT \
  --url https://api.siteqwality.com/escalation_policy/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "repeat_count": 1, "on_exhausted": "notify_owners", "escalate_to_policy_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

• Production

Authorizations

• bearer_auth

Parameters

Path Parameters

policy_id

required

string format: uuid

Escalation policy identifier

Request Body ^required

Media type application/json

object

name

string | null

repeat_count

integer | null format: int32

on_exhausted

One of:

string

Leaving escalate_to_policy clears escalate_to_policy_id.

string

Allowed values: notify_owners stop escalate_to_policy

null

null

escalate_to_policy_id

Allowed only when the policy ends up with on_exhausted: escalate_to_policy.

string | null format: uuid

Responses

200

Escalation policy updated

Media type application/json

object

id

required

string format: uuid

account_id

required

string format: uuid

name

required

string

repeat_count

required

Times to run through every level again after the first pass.

integer format: int32

created_at

required

string format: date-time

levels

array | null

object

id

required

string format: uuid

escalation_policy_id

required

string format: uuid

level_number

required

integer format: int32

timeout_minutes

required

integer format: int32

target_user_ids

required

Array<string>

target_schedule_ids

required

Array<string>

created_at

required

string format: date-time

on_exhausted

What happens when the repeats are used up, or no level reaches anyone.

string

Allowed values: notify_owners stop escalate_to_policy

escalate_to_policy_id

The policy escalate_to_policy runs once; null otherwise.

string | null format: uuid

Example

{
  "on_exhausted": "notify_owners"
}

400

Invalid request body: repeat_count outside 0 to 20, a policy escalating to itself, escalate_to_policy without a fallback or a fallback without it

401

Missing or invalid authentication

404

Policy not found, or escalate_to_policy_id is not a policy of this account

500

Internal server error