Create a ring group
Create a reusable named group of ring destinations referenced from inbound routing. Members are validated against the org before the INSERT — every sip_username must resolve to a live SIP credential, every pstn value must be E.164 with a leading +, and every ring_group member must point at an existing group (self-references and cycles are rejected). Duplicate names within the org return 409. The response carries the created group plus a non-blocking warnings array (e.g. a PSTN number already used in another group). Requires owner/admin.
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
Display name (1–100 chars). Unique per org.
1 - 100How member destinations are offered. Default simultaneous (all destinations ring at once).
simultaneous, sequential, round_robin, longest_idle, fewest_calls Seconds the group tries its members before the inbound route falls through (5–300, default 30).
5 <= x <= 300Ring destinations. sip_username = an org SIP credential username; pstn = E.164 with leading +; ring_group = another group's id (nesting, cycle-checked).
100Response
Created — the resource was created successfully.
The response is of type object.