Skip to content
Reference/Broadcast Groups/Send Template to Group

Send Template to Group

POSThttps://public.leadpattern.com/whatsapp/message/broadcast
Plan: broadcastWhatsApp Connectedapplication/json60 req/min

Send an approved WhatsApp template to all active members of a broadcast group. Opted-out contacts are automatically excluded. Include an optional "scheduledAt" (ISO date-time) to schedule the broadcast for a future time instead of sending immediately.

  • Opted-out contacts are excluded from the recipient count.
  • content.templateData.buttons is not applied on this endpoint — only header, body and cards are.

Headers

1 field
Authorizationstring
required
Your API key. Sent raw (e.g. 'lp_...'). No Bearer prefix required.

Body Parameters

3 fields
groupNamestring
required
Name of the broadcast group to send to.
contentobject
required
templateNamestring
required
Template name (must be APPROVED).
languagestring
optionaldefault: en
Template language code.
templateDataobject
optional
scheduledAtstring
optional
ISO date-time to send at a future time instead of immediately.

Responses

JSON Response
{
  "type": "success",
  "data": {
    "broadcastId": "664abc123def456789012345",
    "status": "processing",
    "totalRecipients": 150
  }
}

Sample Request Body

{
  "groupName": "VIP Customers",
  "content": {
    "templateName": "promo_offer",
    "language": "en",
    "templateData": {
      "body": {
        "placeholders": [
          "Exclusive 20% off"
        ]
      }
    }
  }
}