Skip to main content
POST
/
v1
/
whatsapp
/
messages
/
send-text
Send Text Message
curl --request POST \
  --url https://karibu.briq.tz/v1/whatsapp/messages/send-text \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "recipient": "<string>",
  "body": "<string>"
}
'
{
  "success": true,
  "data": {
    "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sender_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider_message_id": "<string>"
  },
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errors": null
}

Authorizations

X-API-Key
string
header
required

Headers

X-API-Key
string
required
X-App-ID
string | null

Body

application/json
recipient
string
required

Destination number, digits-only E.164. A leading + is stripped.

Required string length: 4 - 20
Example:

"255712345678"

body
string
required

The text message content.

Required string length: 1 - 4096
sender_id
string<uuid> | null

Sender to send from. When omitted, falls back to the workspace's first active sender.

check_window
boolean
default:true

When true, requires an open 24h window; set false to skip the check.

Response

Sent synchronously (status: sent)

WhatsApp send envelope (WaApiResponse with a WaSendResult data payload).

success
boolean
default:true
required
data
WaSendResult · object
required

Payload returned in data for a successful send.

request_id
string<uuid>
required
errors
null