Send a message
Adds a message to an existing conversation.
/api/conversations/{id}/messagesAdds a message to an existing conversation. The server derives the final sender from the authenticated caller: visitors send as themselves and operators send as the current operator. The default message type is text. Use type=file or type=image with metadata for uploaded files, and replyToId to quote an earlier message. For outbound WhatsApp provider templates, an operator may set metadata.channelTemplateKey and optional string values in metadata.channelTemplateParameters; the configured locale mapping is resolved when the message is delivered. After commit, the server publishes the message to realtime subscribers, updates unread counters, and sends message webhooks.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
conversations:write- Module
- Automation & API module (
api_access) - Organization and site scope
- Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
- Retry behavior
- Non-idempotent: Repeating this request may create duplicate work or side effects. After an ambiguous timeout, check the resource state before retrying.
Path Parameters
Resource identifier.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidHeader Parameters
DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body accepted by this operation.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "id": "7f1f4d83-0a0e-4f34-9c4b-9a98d6e1c2ab", "orgId": "8a8f4d83-0a0e-4f34-9c4b-9a98d6e1c2ab", "conversationId": "9f1f4d83-0a0e-4f34-9c4b-9a98d6e1c2ab", "senderType": "operator", "senderId": "6f1f4d83-0a0e-4f34-9c4b-9a98d6e1c2ab", "content": "Hello, how can I help you today?", "type": "text", "metadata": {}, "isRead": false, "isEdited": false, "editedAt": null, "createdAt": "2026-06-23T08:00:00.000Z", "deletedAt": null, "replyToId": null, "mentions": [], "searchVector": "'hello':1 'help':6 'today':8", "quotedMessage": null}Request examples
curl
curl --request POST \
'https://api.convor.io/api/conversations/11111111-1111-4111-8111-111111111111/messages' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"senderType": "operator",
"content": "Hello, how can I help you today?",
"type": "text"
}'JavaScript
const response = await fetch("https://api.convor.io/api/conversations/11111111-1111-4111-8111-111111111111/messages", {
method: "POST",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"senderType": "operator",
"content": "Hello, how can I help you today?",
"type": "text"
}),
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?