Send Message

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 '
{
  "channel": "whatsapp",
  "content": "<string>",
  "lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "html": "<string>",
  "subject": "<string>",
  "components": [
    {
      "parameters": [
        {
          "text": "<string>"
        }
      ]
    }
  ],
  "begin_message": "<string>",
  "voice_tool_allowlist": [
    "<string>"
  ],
  "author_type": "automation",
  "author_name": "<string>"
}
'

import requests

url = "https://api.getnexor.ai/api/public/messages"

payload = {
    "channel": "whatsapp",
    "content": "<string>",
    "lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "html": "<string>",
    "subject": "<string>",
    "components": [{ "parameters": [{ "text": "<string>" }] }],
    "begin_message": "<string>",
    "voice_tool_allowlist": ["<string>"],
    "author_type": "automation",
    "author_name": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    channel: 'whatsapp',
    content: '<string>',
    lead_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    workflow_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    html: '<string>',
    subject: '<string>',
    components: [{parameters: [{text: '<string>'}]}],
    begin_message: '<string>',
    voice_tool_allowlist: ['<string>'],
    author_type: 'automation',
    author_name: '<string>'
  })
};

fetch('https://api.getnexor.ai/api/public/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getnexor.ai/api/public/messages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'channel' => 'whatsapp',
    'content' => '<string>',
    'lead_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'template_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'workflow_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'html' => '<string>',
    'subject' => '<string>',
    'components' => [
        [
                'parameters' => [
                                [
                                                                'text' => '<string>'
                                ]
                ]
        ]
    ],
    'begin_message' => '<string>',
    'voice_tool_allowlist' => [
        '<string>'
    ],
    'author_type' => 'automation',
    'author_name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getnexor.ai/api/public/messages"

	payload := strings.NewReader("{\n  \"channel\": \"whatsapp\",\n  \"content\": \"<string>\",\n  \"lead_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"html\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"components\": [\n    {\n      \"parameters\": [\n        {\n          \"text\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"begin_message\": \"<string>\",\n  \"voice_tool_allowlist\": [\n    \"<string>\"\n  ],\n  \"author_type\": \"automation\",\n  \"author_name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getnexor.ai/api/public/messages")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"channel\": \"whatsapp\",\n  \"content\": \"<string>\",\n  \"lead_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"html\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"components\": [\n    {\n      \"parameters\": [\n        {\n          \"text\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"begin_message\": \"<string>\",\n  \"voice_tool_allowlist\": [\n    \"<string>\"\n  ],\n  \"author_type\": \"automation\",\n  \"author_name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getnexor.ai/api/public/messages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"channel\": \"whatsapp\",\n  \"content\": \"<string>\",\n  \"lead_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"html\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"components\": [\n    {\n      \"parameters\": [\n        {\n          \"text\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"begin_message\": \"<string>\",\n  \"voice_tool_allowlist\": [\n    \"<string>\"\n  ],\n  \"author_type\": \"automation\",\n  \"author_name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "channel": "whatsapp",
  "type": "text",
  "message_id": "<string>",
  "provider_message_id": "<string>",
  "activity_id": "<string>",
  "call_id": "<string>",
  "call_status": "<string>",
  "provider": "<string>"
}

POST

messages

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 '
{
  "channel": "whatsapp",
  "content": "<string>",
  "lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "html": "<string>",
  "subject": "<string>",
  "components": [
    {
      "parameters": [
        {
          "text": "<string>"
        }
      ]
    }
  ],
  "begin_message": "<string>",
  "voice_tool_allowlist": [
    "<string>"
  ],
  "author_type": "automation",
  "author_name": "<string>"
}
'

import requests

url = "https://api.getnexor.ai/api/public/messages"

payload = {
    "channel": "whatsapp",
    "content": "<string>",
    "lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "html": "<string>",
    "subject": "<string>",
    "components": [{ "parameters": [{ "text": "<string>" }] }],
    "begin_message": "<string>",
    "voice_tool_allowlist": ["<string>"],
    "author_type": "automation",
    "author_name": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    channel: 'whatsapp',
    content: '<string>',
    lead_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    workflow_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    html: '<string>',
    subject: '<string>',
    components: [{parameters: [{text: '<string>'}]}],
    begin_message: '<string>',
    voice_tool_allowlist: ['<string>'],
    author_type: 'automation',
    author_name: '<string>'
  })
};

fetch('https://api.getnexor.ai/api/public/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getnexor.ai/api/public/messages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'channel' => 'whatsapp',
    'content' => '<string>',
    'lead_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'template_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'workflow_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'html' => '<string>',
    'subject' => '<string>',
    'components' => [
        [
                'parameters' => [
                                [
                                                                'text' => '<string>'
                                ]
                ]
        ]
    ],
    'begin_message' => '<string>',
    'voice_tool_allowlist' => [
        '<string>'
    ],
    'author_type' => 'automation',
    'author_name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getnexor.ai/api/public/messages"

	payload := strings.NewReader("{\n  \"channel\": \"whatsapp\",\n  \"content\": \"<string>\",\n  \"lead_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"html\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"components\": [\n    {\n      \"parameters\": [\n        {\n          \"text\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"begin_message\": \"<string>\",\n  \"voice_tool_allowlist\": [\n    \"<string>\"\n  ],\n  \"author_type\": \"automation\",\n  \"author_name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getnexor.ai/api/public/messages")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"channel\": \"whatsapp\",\n  \"content\": \"<string>\",\n  \"lead_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"html\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"components\": [\n    {\n      \"parameters\": [\n        {\n          \"text\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"begin_message\": \"<string>\",\n  \"voice_tool_allowlist\": [\n    \"<string>\"\n  ],\n  \"author_type\": \"automation\",\n  \"author_name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getnexor.ai/api/public/messages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"channel\": \"whatsapp\",\n  \"content\": \"<string>\",\n  \"lead_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"html\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"components\": [\n    {\n      \"parameters\": [\n        {\n          \"text\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"begin_message\": \"<string>\",\n  \"voice_tool_allowlist\": [\n    \"<string>\"\n  ],\n  \"author_type\": \"automation\",\n  \"author_name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "channel": "whatsapp",
  "type": "text",
  "message_id": "<string>",
  "provider_message_id": "<string>",
  "activity_id": "<string>",
  "call_id": "<string>",
  "call_status": "<string>",
  "provider": "<string>"
}

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.

A call can return HTTP 409 with code: "call_suppressed". No call was placed. Two values of reason relate to leads waiting for the team:

lead_in_support with retryable: false: the lead is waiting for a reply from the team, because the AI agent handed the conversation over. Automated calls to that lead stay paused until the team closes that conversation. Retrying before then returns the same response.
lead_support_unverified with retryable: true: Nexor could not confirm whether the lead is waiting for the team. The same request can be retried after a short wait.

Authorizations

X-API-Key

string

header

required

API key for authentication. Keys are prefixed with nxr_live_.

Body

application/json

channel

enum<string>

required

Available options:

whatsapp

content

string

required

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

Minimum string length: 1

lead_id

string<uuid>

required

Lead to contact

template_id

string<uuid>

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

Minimum string length: 1

workflow_id

string<uuid>

Optional when the lead has exactly one active workflow run; otherwise required to disambiguate.

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'.

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.

Show child attributes

begin_message

string

Custom greeting for call channel. Overrides the workflow default.

voice_tool_allowlist

string[]

Allowed only for call; restricts the voice agent tools for this call.

Required array length: 1 - 20 elements

Pattern: ^[a-z][a-z0-9_]{0,127}$

author_type

enum<string>

default:automation

Available options:

human,

automation

author_name

string

Response

Message sent successfully

success

boolean

Whether the message was sent

channel

enum<string>

Channel used

Available options:

whatsapp,

unsupervised-whatsapp,

imessage,

email,

sms,

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)

provider

string

Provider identifier returned for provider-specific channels.

Last modified on September 27, 2026

Start here

Quickstart

API reference

Build and launch

WhatsApp

Channels

Agents

Meetings

Integrations

Account

Inbox

Developer tools

Support reference

Send Message

Authorizations

Body

Response