API referenceBroadcasts

POST /broadcasts/{broadcastId}/recipients

Add recipients: contactIds, phones (contacts created), recipients [{phone | contactId, components}] or useSegment. Unsubscribed, blocked and duplicate recipients are skipped

POST
/broadcasts/{broadcastId}/recipients

Authorization

BearerAuth
headerAuthorizationBearer <token>

API key sk_...

Path Parameters

broadcastId*string

Broadcast id

Request Body

application/json
  1. body
contactIds?array<string>
phones?array<string>
recipients?array<>
useSegment?boolean

Response Body

{success, added, skipped}

application/json
  1. response
success?boolean
added?integer
skipped?integer
Example Request
curl -X POST 'https://example.com/api/v1/broadcasts/string/recipients' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "success": true,  "added": 0,  "skipped": 0}

GET /broadcasts/{broadcastId}/recipients GET

Recipients with delivery status (filter by status) and summary totals

POST /broadcasts/{broadcastId}/schedule POST

Schedule a draft (or move a scheduled broadcast) to scheduledAt; the worker sends it then