Skip to main content
POST
Create a ring group

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
name
string

Display name (1–100 chars). Unique per org.

Required string length: 1 - 100
strategy
enum<string>

How member destinations are offered. Default simultaneous (all destinations ring at once).

Available options:
simultaneous,
sequential,
round_robin,
longest_idle,
fewest_calls
ringTimeoutSec
number

Seconds the group tries its members before the inbound route falls through (5–300, default 30).

Required range: 5 <= x <= 300
members
object[]

Ring destinations. sip_username = an org SIP credential username; pstn = E.164 with leading +; ring_group = another group's id (nesting, cycle-checked).

Maximum array length: 100

Response

Created — the resource was created successfully.

The response is of type object.