Skip to main content
POST
/
v1
/
whatsapp
/
messages
/
send-template
Send Template Message
curl --request POST \
  --url https://karibu.briq.tz/v1/whatsapp/messages/send-template \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "sender_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "template_name": "<string>",
  "recipient": "<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
sender_id
string<uuid>
required

The sender that owns the template.

template_name
string
required

Name of the approved template to send.

Required string length: 1 - 512
recipient
string
required
Required string length: 4 - 20
Example:

"255712345678"

variables
Variables · object

Template variable values keyed by placeholder name.

callback_data
string | null

Opaque data you can correlate with webhooks.

Maximum string length: 512

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