Skip to main content
POST
Create a conversation

Authorizations

Authorization
string
header
required

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

Body

application/json

Parameters for creating a new conversation

agentId
string
required

ID of the agent (chatbot) to create the conversation for

Example:

"clx1234567890abcdef"

contactId
string

Optional existing contact ID. If not provided, a new contact will be created.

Example:

"contact_1234567890"

integrationType
enum<string>

Optional integration type for the conversation

Available options:
WHATSAPP,
SLACK
Example:

"WHATSAPP"

ip
string

Optional client IP address (used when creating a new contact)

Example:

"192.168.1.1"

country
string

Optional client country code (used when creating a new contact)

Example:

"US"

Response

Conversation created successfully

status
string
Example:

"success"

data
object