---
title: "Whatsapp template"
method: POST
path: "/streams/whatsapp/template"
tags: ["Streams Service"]
---

# Whatsapp template

`POST /streams/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).

## Request body

- object
  - `sender` string, required — The WhatsApp Business sender number the template is sent from.
  - `event` string, required — The approved template’s event name.
  - `recipients` object[], required — Recipients to send the template to.
    - `internal_id` string — Your identifier for this recipient, echoed back.
    - `recipient_phone` string, required — Recipient phone number in international format, digits only.
    - `template_variables` object, required — Variables for each template component. Keys inside each object are the placeholder names.
      - `HEADER` object — Variables for the template header.
      - `BODY` object — Variables for the template body.
      - `FOOTER` object — Variables for the template footer.

## Response `200`

The template message was accepted for delivery.

- object
  - `status` boolean — `true` when the batch was accepted. Individual messages may still carry an `error`.
  - `task_id` string — Identifier for the accepted batch (processed asynchronously).
  - `messages` object[] — One entry per submitted message, in request order.
    - `internal_id` string — The `internal_id` you supplied, echoed back.
    - `message_uuid` string — Platform-assigned unique identifier for the message.
    - `conversation_uuid` string — The conversation this message belongs to.
    - `error` string — Present only when this message failed: the hex error code (e.g. `0x31`). See Error handling in the Overview.
    - `details` string — Human-readable detail for a failed message.

---

[API](https://skmtc.net/commpeak/apis/dialer-api-v2-0-1.md) · [All operations](https://skmtc.net/commpeak/apis/dialer-api-v2-0-1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/commpeak/dialer-api-v2-0-1/versions/eacecf960bb6/schema)