Handle outbound message for agent

Queues an outbound message for sending via the RCS channel. The agent must exist and not be suspended, and the caller must have permission to send messages for the agent.

Two optional correlation fields behave differently — note the asymmetry:

  • correlateId (max 128 chars) tracks outbound campaigns through delivery reports and inbound replies. It is not sticky: omitting it on a subsequent send clears any existing value on the conversation.
  • conversationMetadata (JSON object, max 2048 chars serialized) attaches business context that persists on the conversation and is echoed back on inbound replies. It is sticky: omitting it does not clear an existing value.

Both are returned on the matching EndUserWebhookPayload callbacks as correlateId and conversationMetadata.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier for the agent

Body Params

Outbound message request payload

Payload for queueing an outbound message on an agent.

string
required
length ≥ 1
^\+1[2-9][0-9]{2}[2-9][0-9]{6}$

Recipient phone number in E.164 format. The pattern currently accepts US/NANP +1 numbers only.

string
enum
required

Message type. Must match the shape of messageContent.

Allowed:
messageContent
required

Message content matching messageType.

string
length between 0 and 128

Optional correlation ID for tracking outbound campaigns through delivery reports and inbound replies. Returned as correlateId on callbacks. Not sticky — sending without this field clears any existing value on the conversation.

conversationMetadata
object

Optional business context to persist on the conversation. Returned as conversationMetadata on inbound callbacks. Sticky — omitting it does NOT clear an existing value.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json