Broadcast Groups API
LeadPattern Broadcast Groups API: 7 endpoints with request parameters, response schemas, error codes and cURL, Node.js and Python examples.
POSTCreate Broadcast Group
/groupsCreate a new broadcast group and optionally seed it with members. Groups are used to send template messages to multiple contacts at once.GETList Broadcast Groups/groups?orderBy=DATE_CREATED&format=DESCENDINGRetrieve broadcast groups with cursor-based pagination. Supports search, ordering by name or creation date.POSTAdd Members to Group/groups/:groupId/membersAdd new contacts to an existing broadcast group. Contacts are upserted — existing contacts are not duplicated.DELETEDelete Broadcast Groups/groupsDelete one or more broadcast groups by their IDs.POSTSend Template to Group/whatsapp/message/broadcastSend 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.GETGet Broadcast Analytics/groups/broadcasts/:idRetrieve delivery/read/reply stats for a broadcast (broadcastId returned from Send Template to Group).GETGet Broadcast Recipients/groups/broadcasts/:id/recipients?page=1&limit=20Retrieve the per-recipient delivery breakdown for a broadcast. Filter by status: sent, delivered, failed, replied, noResponse, unread.