Add contacts to broadcast
Add contacts to a broadcast in batch. Maximum 1000 contacts per request.
Authorization
AuthorizationheaderrequiredBearer YOUR_API_KEY. Create a key in the dashboard.
Path parameters
broadcastIdstringrequired
Body
application/json
contactsobject[]requiredList of contacts to add (max 1000 per request).
Limitsmax items 10004 properties
recipientstringrequiredPhone number (E.164) or email address. On a
telegrambroadcast, the numeric chat ID of someone who has already written to your bot (838360395, ortelegram:838360395); a phone number is rejected there, because a bot cannot start a chat.templateVariablesobjectPer-contact body variables. Key them to match the template body: by position (
1,2, ...) for positional templates, or by name (e.g.customer_name) for named templates. Zavu detects the template's format and sends the correct payload to Meta. Do not mix positional and named keys.1 properties
{key}string
templateButtonVariablesobjectPer-contact button variables for dynamic URL/OTP buttons. Keys are the button index (0, 1, 2).
1 properties
{key}string
templateHeaderVariablesobjectPer-contact value for a text-header variable, keyed by
1. If omitted, Zavu resolves the header fromtemplateVariablesby the header placeholder's name.1 properties
{key}string
Responses
201Contacts added.
addedintegerrequiredNumber of contacts successfully added.
duplicatesintegerrequiredNumber of duplicate contacts skipped.
invalidintegerrequiredNumber of invalid contacts rejected.
errorsobject[]Details about invalid contacts.
2 properties
recipientstringreasonstring
400Invalid request or broadcast not in draft status.
codestringrequiredmessagestringrequireddetailsobject
401Unauthorized.
codestringrequiredmessagestringrequireddetailsobject
404Broadcast not found.
codestringrequiredmessagestringrequireddetailsobject