---
title: "Send Whatsapp Template Message"
method: POST
path: "/whatsapp/message/template"
tags: ["Outgoing Messages"]
---

# Send Whatsapp Template Message

`POST /whatsapp/message/template`

Send Whatsapp Template Message

## Request body

- SendWhatsappTemplateMessagesDto
  - `messages` SendWhatsappTemplateMessageDto[], required — Array of template messages to be sent
    - `from` string, phone — The phone number from which the message is sent, with the country code
    - `to` string, phone — The phone number to which the message is sent (with country code). Omit when sending to a group using groupId.
    - `groupId` string — The unique identifier of the WhatsApp group to send the message to. Mutually exclusive with "to".
    - `messageId` string — Message ID (UUID v4) to be used for the message. If not provided, a random UUID v4 will be generated
    - `content` SendTemplateMessageContentDto, required
      - `templateName` string, required — Template name
      - `language` 'en' | 'en_US' | 'en_GB' | 'pt_BR' | 'es' | 'id', required — Template language
      - `templateData` SendTemplateMessageContentTemplateDataDto
        - `header` SendTemplateMessageContentTemplateDataHeaderDto
          - `type` 'TEXT' | 'IMAGE' | 'DOCUMENT' | 'VIDEO' | 'LOCATION' — Template header type
          - `placeholder` string — Template header text
          - `mediaUrl` string — Template header media link (only for IMAGE, VIDEO or DOCUMENT type)
          - `filename` string — Template header document caption
          - `latitude` number — Template header location latitude
          - `longitude` number — Template header location longitude
        - `body` SendTemplateMessageContentTemplateDataBodyDto
          - `placeholders` string[], required — Template body components
        - `buttons` SendTemplateMessageContentTemplateDataButtonDto[] — Template buttons
          - `type` 'URL', required — Template button type
          - `parameter` string — Template button text (Required only when the URL is dynamic)
        - `cards` SendTemplateMessageContentTemplateCarouselCardsDto[] — Template carousel cards
          - `cardIndex` number — Index of the card - 0 Represents the first card
          - `components` object — Carousel cards components
            - `header` object — Carousel card header
              - …
            - `body` SendTemplateMessageContentTemplateDataBodyDto
              - …
            - `buttons` SendTemplateMessageContentTemplateDataButtonDto[] — Carousel card buttons
              - …
    - `customData` object — Arbitrary key-value pairs (string values only) stored against this message. Each entry is spread at the root level of outgoing webhooks: status update webhooks (sent / delivered / read / failed) and received-message webhooks when a customer replies to this template.

## Response `201`

## Other responses

- `400` — Incorrect payload
- `401` — Unauthorized

---

[API](https://skmtc.net/doubletick/apis/doubletick-public-apis.md) · [All operations](https://skmtc.net/doubletick/apis/doubletick-public-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/doubletick/doubletick-public-apis/revisions/bba484527d34/schema)