Skip to main content
POST
Send a free-form WhatsApp session message

Headers

x-api-key
string
required

API key needed to authorize the request

Body

application/json

The session message payload

message
string
required

Free-form text body to send inside the active 24h session

Minimum string length: 1
contact_id
string<uuid>

Vambe contact id to send the message to

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
phone
string

Recipient phone number, used when contact_id is not provided. Keep an explicit "+" for numbers in a different country than the sender

reply_message_id
string

Provider message id to quote when replying

from_phone_number
string

Business WhatsApp number to send from. Required when targeting by "phone" and the account has more than one WhatsApp number

type
enum<string>
default:text

Message type. Only "text" is supported for now

Available options:
text
pause_assistant
boolean
default:true

Pause the AI assistant for this contact (human handoff)

Response

Message accepted for delivery.