Skip to main content
POST
cURL
This endpoint lets you create a new conversation.

Authorizations

X-API-Key
string
header
required

API key authentication. Pass your API key in the X-API-Key header.

Body

application/json
toNumber
string

The phone number of the contact to create the conversation with.

fromNumber
string

The whatsapp number to send the mesage from

agentId
string<uuid>

The ID of the agent to start the conversation with. If this is a new agent for this conversation, it will be a trigger a new session with the agent.

message
object
phoneNumber
string

This has been deprecated. Use toNumber instead.

Response

201 - application/json
id
string<uuid>
required
read-only
contact
object
required
activeAgent
string
required
read-only
whatsappNumber
string
required
read-only
chatWindowRemainingTime
string
required
read-only
lastMessage
string
required
read-only
isHumanTakeover
string
required
read-only
active
string
required
read-only
routing
string
required
read-only
webhookId
string
required
read-only
routingOverride
string
required
read-only
activeSupportHandoff
string
required
read-only
supportHandoffs
string
required
read-only
shopifyCustomer
string
required
read-only