Skip to content

Create an escalation policy.

POST
/escalation_policy
curl --request POST \
--url https://api.siteqwality.com/escalation_policy \
--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" }'
Media type application/json
object
name
required
string
repeat_count

Times to run through every level again after the first pass, 0 to 20. Default 0: every level is paged once.

integer | null format: int32
on_exhausted
One of:

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

string
Allowed values: notify_owners stop escalate_to_policy
escalate_to_policy_id

Required with on_exhausted: escalate_to_policy, and only allowed with it: another policy in this account.

string | null format: uuid

Escalation policy created

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"
}

Invalid request body: repeat_count outside 0 to 20, escalate_to_policy without escalate_to_policy_id or the reverse

Missing or invalid authentication

Escalate_to_policy_id is not a policy of this account

Internal server error