Send a WhatsApp Template

Send a single WhatsApp message: select a template to use and call our endpoint with the recipient phone number and the variables the template needs. That’s it!

POST /api/channels/whatsapp/template/{id}/send

Send a WhatsApp Template

cURL

curl --request POST \
  --url https://api.hilos.io/api/channels/whatsapp/template/{id}/send \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "variables": [
    "<string>"
  ]
}
'

201

{
  "id": "a513da3a-8b73-42aa-a938-0eb1e0141533",
  "conversation": "ee49ab6c-dfd8-4cb6-a512-5880f4385622"
}

This endpoint is for sending templates only. If you want more functionality (like adding tags) use the Create a flow execution endpoint.

Authorizations

Authorization · string · header · required

Token-based authentication with required prefix "Token"

Path Parameters

id · string<uuid> · required

Template Id

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

phone · string · required

The phone number to send the WhatsApp Template to.

Maximum string length: 20

variables · string[]

An array of variables to be used in the WhatsApp Template. Variables are taken in order HEADER, BODY and BUTTONs. (e.g. position 0 corresponds to the HEADER (if it exists) or variable {{1}}, position 1 to variable {{2}} and so on.

Response

201 - application/json

id · string<uuid> · required

Message Id

conversation · string<uuid> · required

Message Conversation Id