Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores. Generate a unique UUID v4 for each operation and reuse it only when retrying that operation with the same request. Invalid headers—including duplicate, empty, malformed, or overlong values—return 400 with error code 10015. A request already in progress with the same key returns 409; reusing the key with a different request returns 422. Only successful responses are replayed, for up to 24 hours. Do not include sensitive data in the key.

Required string length: 1 - 255
Pattern: ^[A-Za-z0-9_-]{1,255}$

Body

application/json

RCS message body

agent_id
string
required

RCS Agent ID

Example:

"Agent007"

to
string
required

Phone number in +E.164 format

Example:

"+13125551234"

messaging_profile_id
string
required

A valid messaging profile ID

agent_message
object
required
type
enum<string>

Message type - must be set to "RCS"

Available options:
RCS
Example:

"RCS"

webhook_url
string<url>

The URL where webhooks related to this message will be sent.

sms_fallback
object
mms_fallback
object

Response

Successful operation

data
object