Skip to main content
POST
Preview a call-delegation policy plan

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

Body

application/json
executive_user_id
string
required

The executive who OWNS every call routed by this policy.

Required string length: 1 - 128
grants
object[]
required

One grant per delegated assistant.

Required array length: 1 - 10 elements
ring_mode
enum<string>
default:screen_first

How the inbound call distributes across the executive + assistant lines.

Available options:
screen_first,
simul_ring,
assistant_first,
exec_first
screen_timeout_sec
integer
default:20

Per-stage screen/alert window (seconds) before rolling on.

Required range: 5 <= x <= 120
shared_ownership
boolean
default:true

When true, an answering assistant shares ownership of the call with the executive (either can transfer/end/re-take).

Response

Successful response.

data
object
required
meta
object
required