Skip to main content
POST
Send a message as a contact on a channel

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

Org ID

contact_id
string
required

Contact ID

channel_id
string
required

Channel ID

chat_id
string
required

Chat ID

Body

message
object[]
required

The message content, authored as the contact.

Minimum array length: 1

User message parts

Response

200 - application/json

The chat message schema

id
string
required
role
enum<string>
required

The role of the message

Available options:
user,
assistant,
system,
tool,
event,
note
model
string
required

The model used for the message

status
enum<string>
required

The chat status

Available options:
RUNNING,
COMPLETED,
FAILED,
CANCELED
created_at
string<date-time> | null
required
updated_at
string<date-time> | null
required
messages
object[]

The message content

System message

member
object

The member of the chat

error
string

Error message if the message failed

broadcast_id
string

ID of the broadcast this message originates from

is_broadcast_message
boolean

Whether this message was sent via a broadcast template

usage
object

The usage information for the message

delivered_at
string<date-time> | null

When the message was delivered to the recipient

seen_at
string<date-time> | null

When the recipient saw the message