Skip to main content
POST
Send an outbound message

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 WhatsApp provider runs in mock mode. False once the platform sends via the live provider (WHATSAPP_PROVIDER=twilio).