Skip to main content
POST
Los mensajes de texto libre (content) no pueden llevar un archivo adjunto. Para mandar una imagen, video o documento, usa template_id con una plantilla cuyo formato de header coincida, y pasa la URL del archivo en un componente header dentro de components (ver el ejemplo whatsapp_template_with_document más abajo). Las plantillas también funcionan fuera de la ventana de 24 horas de servicio al cliente. Crea y aprueba plantillas desde Integraciones → WhatsApp → Plantillas — ver Plantillas de mensaje.

Autorizaciones

​
X-API-Key
string
header
requerido

API key for authentication. Keys are prefixed with nxr_live_.

Cuerpo

application/json
​
lead_id
string<uuid>
requerido

Lead to contact

​
workflow_id
string<uuid>
requerido

Workflow that determines channel configuration

​
channel
enum<string>
requerido

Delivery channel

Opciones disponibles:
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.

Respuesta

Message sent successfully

​
success
boolean

Whether the message was sent

​
channel
enum<string>

Channel used

Opciones disponibles:
whatsapp,
email,
call
​
type
enum<string>

WhatsApp only: message type

Opciones disponibles:
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)

Última modificación el 8 de julio de 2026