Skip to main content
PATCH
Update a wallboard alarm rule

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

ruleId
string
required

Rule id (wbalarm_*).

Minimum string length: 1

Body

application/json

At least one field required (queue_id / name / metric / comparator / threshold / duration_seconds / channel / enabled).

At least one field required (queue_id / name / metric / comparator / threshold / duration_seconds / channel / enabled).

queue_id
string | null

Queue scope. Omitted or null = tenant-wide rule applying to every queue.

Minimum string length: 1
name
string
Required string length: 1 - 120
metric
enum<string>
Available options:
waiting,
longest_wait,
avg_wait,
predicted_wait,
agents_available,
agents_total,
service_level,
abandoned_rate
comparator
enum<string>
Available options:
gt,
gte,
lt,
lte,
eq
threshold
number
duration_seconds
integer

Sustained breach window in seconds — 0 fires on the first breaching tick.

Required range: 0 <= x <= 86400
channel
enum<string>
Available options:
sse,
sse+notification,
webhook,
email
enabled
boolean

Response

Successful response.

data
object
required

The updated rule row.

meta
object