Skip to main content
POST
Add a conversation message

Headers

X-Conversation-Token
string
required

Opaque participant token returned only when the conversation is created.

Required string length: 32 - 128
Idempotency-Key
string

Stable 8–120 character key for safe mutation retries.

Required string length: 8 - 120

Path Parameters

page
string
required

Published page UUID or slug.

conversation
string<uuid>
required

Body

application/json

Provide body or the ID of a native_chat/request_human reply. Popup, app-widget, and URL actions are dispatched by the Contact Button runtime.

body
string
Maximum string length: 10000
suggested_reply_id
string<uuid>
button_id
string<uuid>
sender_type
enum<string>
Available options:
visitor,
agent
agent_context
object

Response

200 - application/json

Successful data envelope.

data
any
required
meta
object
required