Skip to main content
POST
Register a seed-lab test recipient

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
e164
string
required

Handset number, validated and normalized to E.164.

label
string
required

Friendly label (device, SIM, or tester name).

channel
enum<string>

Handset channel this recipient tests. Defaults to sms.

Available options:
sms,
mms,
rcs
expected_mccmnc
string

Expected destination MCCMNC (5-6 digits), when known.

expected_carrier
string

Expected operator label.

country
string

Expected ISO 3166-1 alpha-2 country code.

Response

The new recipient plus the full roster.

The new recipient plus the full roster.

data
object
meta
object