Skip to main content
POST
Free-form content messages cannot carry a file. To send an image, video, or document, use template_id with a template whose header format matches, and pass the file’s URL in a header component under components (see the whatsapp_template_with_document example below). Templates also work outside the 24-hour customer service window. Create and approve templates from Integrations → WhatsApp → Templates — see Message templates.

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Body

application/json
​
lead_id
string<uuid>
required

Lead to contact

​
workflow_id
string<uuid>
required

Workflow that determines channel configuration

​
channel
enum<string>
required

Delivery channel

Available options:
whatsapp,
email,
call
​
content
string

Plain text message body. Required for whatsapp (unless using template_id). For email: use content for plain text or html for formatted email.

​
html
string

HTML email body. When provided, the email is sent with this HTML directly (not escaped). Use instead of content for formatted emails.

​
subject
string

Email subject line. Defaults to 'Message from your advisor'.

​
template_id
string<uuid>

WhatsApp template ID. Sends a template message instead of free-form text.

​
components
object[]

Template parameters in Meta format. Used with template_id. To send a file (image, video, or document) as part of the message, include a header component whose parameter carries the file — see the whatsapp_template_with_document request example. The template must already be approved with a matching header format; free-form content messages cannot carry attachments.

​
begin_message
string

Custom greeting for call channel. Overrides the workflow default.

Response

Message sent successfully

​
success
boolean

Whether the message was sent

​
channel
enum<string>

Channel used

Available options:
whatsapp,
email,
call
​
type
enum<string>

WhatsApp only: message type

Available options:
text,
template
​
message_id
string | null

Internal message identifier

​
provider_message_id
string | null

WhatsApp only: Meta wamid

​
activity_id
string | null

Email only: delivery tracking ID

​
call_id
string | null

Call only: call identifier

​
call_status
string | null

Call only: initial status (registered)

Last modified on July 8, 2026