Skip to main content
The Send Message endpoint delivers a message to a contact on one of their active channel inboxes. You can send plain text, file attachments, or trigger a specific flow node. If you specify an inboxId, the message is sent on that inbox’s channel; if you omit it, ChatbotX sends on the last channel the contact interacted on. A successful request returns HTTP 204 No Content.
POST /api/v1/contacts/{identifier}/messages

Path Parameters

string
required
A contact lookup string. Minimum length: 1 character.

Request Body

string
The text content of the message. Must be between 1 and 1,000 characters. Required if files or flowId is not provided.
array
Array of file attachments to send. Minimum 1 item when provided.
string
ID of the flow to trigger for this contact. Must be a numeric string matching the pattern \d+.
string
ID of a specific flow node to start from. Must be a numeric string matching the pattern \d+.
string
ID of the inbox (channel) to send the message on. If omitted, ChatbotX uses the contact’s last active channel. Must be a numeric string matching \d+.
string
An optional client-side idempotency identifier. Must be a numeric string matching \d+.

Code Examples

Response

A successful request returns HTTP 204 No Content with no response body, confirming the message was queued for delivery.
Always test message sending on a test contact before running bulk operations to verify message delivery.