Skip to main content
POST
Start conversation

Authorizations

Authorization
string
header
required

Server-side tenant-scoped credential created from Build > API Keys.

Headers

Idempotency-Key
string
required
Required string length: 1 - 200

Body

application/json
channel
enum<string>
required
Available options:
whatsapp
targetChannelId
string
required
Required string length: 1 - 120
phoneNumber
string
required
Required string length: 8 - 32
locale
enum<string>
required
Available options:
en_US,
es_MX
messageText
string
required
Required string length: 1 - 1024
Available options:
true
contactName
string
Maximum string length: 200

Response

Accepted and queued, not delivered

conversationId
string
required
status
enum<string>
required
Available options:
queued
replyId
string
requestEventId
string