Sign in
OpenAPI 3.1.02026-08-185681822.2 MB

d0ab3b4eb0ae

Broadcasts

Add recipients to a broadcast

Add recipients by contact IDs, raw phone numbers, or from the broadcast's segment filters.

post/v1/broadcasts/{broadcastId}/recipients

Path parameters

broadcastIdstring required

Request body

contactIdsstring[]

Specific contact IDs to add. Zernio contact ids (24-character hex), as returned by the list-contacts endpoint. A platform identifier such as a WhatsApp wa_id is rejected with 400; use phones for raw numbers.

phonesstring[]

Raw phone numbers (auto-creates contacts). Useful for WhatsApp/Telegram manual entry

useSegmentboolean

Auto-populate from broadcast segment filters

Response

Recipients added

successboolean
addedinteger

Number of recipients successfully added

skippedinteger

Number skipped (duplicates or missing channels)