v1

latestOpenAPI 3.0.32026-07-24156161.2 MB

Streams Service

Whatsapp template

Send an approved WhatsApp Business template message to one or more recipients. Identify the template with event, and supply its component variables (HEADER, BODY, FOOTER) per recipient.

sender is the WhatsApp Business number the template is sent from.

Authentication: stream token in the Authorization header (see Authentication in the API Overview).

post/streams/whatsapp/template

Request body

senderstring required

The WhatsApp Business sender number the template is sent from.

eventstring required

The approved template’s event name.

Example request

{
  "sender": "447700900123",
  "event": "welcome_message",
  "recipients": [
    {
      "internal_id": "1001",
      "recipient_phone": "447700900124"
    }
  ]
}

Response

The template message was accepted for delivery.

statusboolean

true when the batch was accepted. Individual messages may still carry an error.

task_idstring

Identifier for the accepted batch (processed asynchronously).

Example response

{
  "status": true,
  "task_id": "ca550f7e-9eb5-45b3-9830-e82b407ede02",
  "messages": [
    {
      "internal_id": "1001",
      "message_uuid": "a61e5bfe-c82b-448a-815b-32de8bf22089",
      "conversation_uuid": "e2a489db-bb8a-4f51-9692-726153599c57",
      "error": "0x31",
      "details": "reached daily limit"
    }
  ]
}