Skip to main content
PUT
Upsert my call-forwarding rule

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
mode
enum<string>
required

Call-handling mode to apply.

Available options:
none,
forward_all,
sim_ring,
sequential,
forward_after_timeout
destinations
object[]

Ordered forwarding targets (max 5). Defaults to empty.

Maximum array length: 5
ring_timeout_sec
integer
default:20

Seconds to ring before the rule falls through. Defaults to 20.

Required range: 5 <= x <= 120
active_from
string<date-time> | null

ISO-8601 timestamp the rule starts applying (null/omitted = always-on).

active_until
string<date-time> | null

ISO-8601 timestamp the rule stops applying (null/omitted = always-on).

note
string | null

Optional free-text note (max 280 chars).

Maximum string length: 280
reject_anonymous
boolean
default:false

Decline inbound legs with a withheld/anonymous caller-id before any fan-out. Defaults to false.

Response

Successful response.

data
object
required
meta
object
required