Zernio
Zernio
API Reference

Broadcasts

List broadcast recipientsGETList broadcastsGETCreate broadcast draftPOSTGet broadcast detailsGETUpdate broadcastPATCHDelete broadcastDELETEAdd recipients to a broadcastPOSTCancel broadcastPOSTSchedule broadcast for laterPOSTSend broadcast nowPOST
Dashboard
llms.txtOpenAPI
OverviewPlatformsAPI ReferenceResources
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

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Path Parameters

broadcastId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

{  "success": true,  "added": 0,  "skipped": 0}
Was this page helpful?

Delete broadcast

Permanently delete a broadcast. Only drafts can be deleted.

Cancel broadcast

Cancel a scheduled or in-progress broadcast. Already-sent messages are not affected.

contactIds?array<string>

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.

phones?array<string>

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

Itemsitems <= 20000
useSegment?boolean

Auto-populate from broadcast segment filters