Skip to main content
POST
Start a conversation

Headers

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.

Body

application/json

Provide message or suggested_reply_id. Suggested reply messages and event labels are always resolved server-side.

mode
enum<string>
Available options:
human,
agent_assisted,
agent_to_agent
visitor_name
string
visitor_email
string<email>
visitor_phone
string
Maximum string length: 40
phone_country
string
Maximum string length: 4
subject
string
message
string
Maximum string length: 10000
suggested_reply_id
string<uuid>
button
string<uuid>

Optional active Button context for an embedded Agent Chat App.

app
string<uuid>

Optional published Agent Chat App attached to button.

requested_by
enum<string>
Available options:
human,
agent
agent_context
object

Response

Successful data envelope.

data
any
required
meta
object
required