Skip to main content
PATCH
Update a monitor rule

Authorizations

Authorization
string
header
required

Your v3 API key, e.g. ask_live_…

Headers

X-Subaccount-Id
string

Target subaccount for the request. Required unless the API key is authorized for exactly one subaccount (then it defaults to that one). Alternatively pass subaccount_id (or legacy location_id) in the request body. Omitting it on a multi-subaccount key returns 400 subaccount_required.

Path Parameters

id
string
required
Minimum string length: 1

Body

application/json
name
string
Required string length: 1 - 200
description
string | null
Maximum string length: 2000
evaluator_prompt
string
Minimum string length: 1
category
enum<string>

Alert category: COMPLIANCE, QUALITY, SAFETY, ESCALATION, or CUSTOM.

Available options:
COMPLIANCE,
QUALITY,
SAFETY,
ESCALATION,
CUSTOM
trigger_on
enum<string>

Which interactions a rule evaluates: CALL, CHAT, or BOTH.

Available options:
CALL,
CHAT,
BOTH
severity
enum<string>

Severity: LOW, MEDIUM, HIGH, or CRITICAL.

Available options:
LOW,
MEDIUM,
HIGH,
CRITICAL
threshold
integer
Required range: 1 <= x <= 9007199254740991
threshold_window_mins
integer
Required range: 0 <= x <= 9007199254740991
cooldown_mins
integer
Required range: 0 <= x <= 9007199254740991
enabled
boolean
routing
object[]

If provided, REPLACES all existing routing channels for the rule.

subaccount_id
string

Target subaccount id. Prefer the X-Subaccount-Id header; this body field is a fallback.

location_id
string

Alias for subaccount_id (GHL location id).

Response

Success

data
object
required
request_id
string
required
error
null