Skip to content

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

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

Parameters

  • broadcastId (path, string) required

Request body

Content-Type: application/json

  • contactIds (array) — Specific contact IDs to add
  • phones (array) — Raw phone numbers (auto-creates contacts). Useful for WhatsApp/Telegram manual entry
  • useSegment (boolean) — Auto-populate from broadcast segment filters

Responses

200 — Recipients added

  • success (boolean)
  • added (integer) — Number of recipients successfully added
  • skipped (integer) — Number skipped (duplicates or missing channels)

401

404