Automations · Broadcasts

Add recipients to a broadcast

Adds recipients to a broadcast.

POSThttps://api.pozy.ai/v1/broadcasts/{broadcastId}/recipients
addBroadcastRecipients

Guides: Broadcasts, WhatsApp broadcasts

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

NameTypeNotes
broadcastIdrequiredstring

Request body

application/json, required

  • contactIdsarray of string
  • phonesarray of string

    Up to 20000 items.

  • useSegmentboolean

Example

curl -X POST "https://api.pozy.ai/v1/broadcasts/6ce1988a4c4f8bc6d3ca157a/recipients" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "contactIds": [
    "string"
  ],
  "phones": [
    "+14155550123"
  ],
  "useSegment": true
}'

Response

200 on success

  • successboolean
  • addedinteger
  • skippedinteger
200 response
{
  "success": true,
  "added": 1,
  "skipped": 1
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Broadcasts