Ricky logorickyDocs

Preview a broadcast audience

POST
/broadcasts/preview

Counts the numbers an audience resolves to now, with the rules POST /broadcasts uses, without creating anything. The list can change before you create the broadcast.

Scope: broadcasts:read.

Authorization

bearerAuth
headerAuthorizationBearer <token>

An organization API key, rky_live_…, created in Settings → API. Send it only from a server.

Request Body

application/json
  1. body

The audience to count, as you would send it to POST /broadcasts.

audience*||

Who receives it. filter takes every contact matching all the filters you send (no filter: every contact); contacts and phones take the ones you list. Ricky uses each contact’s phone, or its WhatsApp number, skips contacts without one and sends once per number, up to 5,000.

Response Body

Success.

application/json
  1. response
data*

How many numbers an audience resolves to now.

curl -X POST 'https://getricky.ai/api/v1/broadcasts/preview' \  -H 'Content-Type: application/json' \  -d '{  "audience": {    "type": "filter",    "tag_id": "5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f"  }}'
{  "data": {    "recipients": 118,    "skipped": 3  }}