Send Message

curl --request POST \ --url https://api.getnexor.ai/api/public/messages \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <api-key>' \ --data ' { "lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "content": "<string>", "html": "<string>", "subject": "<string>", "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "components": [ {} ], "begin_message": "<string>" } '

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.

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)