Upsert my call-forwarding rule
Creates or replaces the authenticated user’s own call-forwarding rule. Idempotent upsert keyed on the user. PSTN destinations must be E.164 and SIP destinations must be sip:-prefixed, else 400. Returns the resolved rule.
Authorizations
Dashboard JWT token from Clerk
Headers
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.
1 - 255Sandbox 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.
true, false Body
Call-handling mode to apply.
none, forward_all, sim_ring, sequential, forward_after_timeout Ordered forwarding targets (max 5). Defaults to empty.
5Seconds to ring before the rule falls through. Defaults to 20.
5 <= x <= 120ISO-8601 timestamp the rule starts applying (null/omitted = always-on).
ISO-8601 timestamp the rule stops applying (null/omitted = always-on).
Optional free-text note (max 280 chars).
280Decline inbound legs with a withheld/anonymous caller-id before any fan-out. Defaults to false.