Skip to main content
POST
Send an RCS message

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

Recipient phone number in E.164 format.

from
string

Sender identifier.

body
string

Plain text message body. Required for text sends; omit when sending a rich_card or rich_card_carousel.

Maximum string length: 4096
media_url
string
Maximum string length: 2048
webhook_url
string
Maximum string length: 2048
metadata
object

Free-form string metadata. Caller-supplied keys win on conflict with provider flags translated from rich_card/rich_card_carousel.

scheduled_at
string
rich_card
object

Standalone rich card payload (Twilio / Verizon parity). Mutually exclusive with rich_card_carousel.

Horizontal carousel of 2-10 rich cards (Twilio / Verizon parity). Single-card carousels render as malformed on Android — use rich_card for single cards.

Response

Message accepted for delivery (rcs)

Message accepted for delivery (rcs)

data
object
meta
object