Skip to main content
POST
/
api
/
v1
/
conversations
/
{id}
/
send
Send an outbound message
curl --request POST \
  --url https://app.vorel.ai/api/v1/conversations/{id}/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>",
  "language": "ar"
}
'
{
  "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sequence_number": 2,
  "sent_at": "2023-11-07T05:31:56Z",
  "mocked": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.vorel.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Tenant-issued API key. Format: vapk_live_<48 hex chars> (60 chars total). Issue + manage at /settings/integrations/api-keys in the Vorel dashboard. Each key has a scope set (read, leads:write, appointments:write, offerings:write); endpoints requiring a write scope reject keys without it with a 403 envelope.

Path Parameters

​
id
string<uuid>
required

UUID of the conversation to send into.

Body

application/json

Operator-initiated outbound copy. Treated as authoritative — no hallucination grading, no guardrail rewrites. Operators are accountable for the wording.

​
text
string
required
Required string length: 1 - 4096
​
language
enum<string>
Available options:
ar,
en,
mixed

Response

Message persisted + queued for outbound delivery.

​
message_id
string<uuid>
required
​
sequence_number
integer
required
Required range: x >= 1
​
sent_at
string<date-time>
required
​
mocked
boolean
required

True while the platform runs in MOCK_EXTERNAL mode (Phase 4a). Phase 4b 360dialog integration flips this to false.