Skip to main content
POST
Escalate conversation

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
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

id
string
required

Body

application/json
reason
string

Free-text reason — surfaced in Slack + email body and stored on metadata.escalation.reason.

Maximum string length: 500
priority
enum<string>

Escalation priority. Default 'urgent'. Drives Slack button styling (danger vs primary) and email subject prefix.

Available options:
normal,
high,
urgent
target_user_ids
string[]

Optional caller override of recipients. Each id is validated against the caller's organizationId so a malicious or buggy caller cannot leak the notification to another tenant's users. When omitted, falls back to organizations.settings.escalation.user_ids.

Maximum array length: 20
Maximum string length: 64
notify_channels
enum<string>[]

Opt-out lever for individual notification channels. Default ['slack','email'] (both). Useful for tests / programmatic callers that only want one fan-out path.

Maximum array length: 2
Available options:
slack,
email

Response

Successful response.