Broadcasts

Add recipients to a broadcast

Changed on

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

post/v1/broadcasts/{broadcastId}/recipients

Request

  • Base URL: https://zernio.com/api
  • URL: https://zernio.com/api/v1/broadcasts/{broadcastId}/recipients
  • Auth: HTTP bearer

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)

Changes

  • f8c8f34fb41aRevision changes
    • warning

      added the new account enum value to the / response property for the response status

  • d556591af3f6Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status