Skip to main content
POST
Add a member to a shared line

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

Path Parameters

id
string
required

Shared line id.

Minimum string length: 1

Body

application/json
memberKind
enum<string>

Whether memberValue is interpreted as a SIP extension username (sip_extension, default) or an auth user id (user_id).

Available options:
sip_extension,
user_id
memberValue
string

The extension username or user id to ring on inbound calls.

Required string length: 1 - 128
canGrab
boolean

Whether this member may grab the answered call via /:id/grab (default true).

sortOrder
number

Ring preference order (0–999). Omitted = appended after the current roster.

Required range: 0 <= x <= 999

Response

Created — the resource was created successfully.

The response is of type object.