Skip to main content
POST
Send An Outbound Message Via Whatsapp

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Body

application/json
whatsapp_phone_number_id
string
required
whatsapp_user_id
string
required
template_name
string
required
template_language_code
string
required
template_params
(WhatsAppTemplateHeaderComponentParams · object | WhatsAppTemplateBodyComponentParams · object | WhatsAppTemplateButtonComponentParams · object)[]
required
agent_id
string
required
conversation_initiation_client_data
ConversationInitiationClientDataRequest · object | null

Response

Successful Response

conversation_id
string
required