Skip to main content
POST
Create messaging service

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

Human-readable name (1–200 chars, required).

sender_pool_id
string

Default sender pool the send path resolves from through.

opt_out_list_id
string
inbound_webhook_url
string
inbound_method
enum<string>
Available options:
POST,
GET
mps_cap
integer

Optional throughput cap (messages/sec).

Required range: 1 <= x <= 1000
external_id
string

Twilio MGxxx / opaque vendor id for migrator import.

Response

The created messaging service (with its assigned id and timestamps) wrapped in the standard { data, meta } envelope. Returns 409 when external_id is already mapped and 422 when the body is invalid.

The created messaging service (with its assigned id and timestamps) wrapped in the standard { data, meta } envelope. Returns 409 when external_id is already mapped and 422 when the body is invalid.