---
title: "Send Template Whatsapp Message to Broadcast Group"
method: POST
path: "/whatsapp/message/broadcast"
tags: ["Broadcast Groups"]
---

# Send Template Whatsapp Message to Broadcast Group

`POST /whatsapp/message/broadcast`

Send a template WhatsApp message to a broadcast group. When using placeholders in your message, please follow the format outlined below:

- {{Name}}: Used to include the name of the customer.
- {{Phone Number}}: Used to include the phone number of the customer.
- {{<Custom Field Name>}}: Used to include custom fields. This will only function correctly if the custom field has been set for all customers within the broadcast group.

## Request body

- SendWhatsAppBroadcastRequestDto
  - `groupName` string, required — The name of the WhatsApp group to send the message to
  - `from` string, phone — The phone number from which the message is sent, with the country code
  - `content` SendTemplateMessageContentDto
    - `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
            - `type` 'IMAGE' | 'VIDEO' — Carousel card header type
            - `mediaUrl` string — Carousel card header media link (only for IMAGE, VIDEO type)
          - `body` SendTemplateMessageContentTemplateDataBodyDto
            - `placeholders` string[], required — Template body components
          - `buttons` SendTemplateMessageContentTemplateDataButtonDto[] — Carousel card buttons
            - `type` 'URL', required — Template button type
            - `parameter` string — Template button text (Required only when the URL is dynamic)

## Response `200`

OK

- SendWhatsAppBroadcastResponseDto
  - `status` 'SENT' | 'FAILED', required — The status of the sent message (SENT or FAILED)
  - `messageId` string, required — The ID of the sent message
  - `errorMessage` string — The error message in case of a failed message

## Other responses

- `400` — Bad request, invalid input provided
- `401` — Invalid or missing API key

---

[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/versions/bba484527d34/schema)