Skip to main content
POST
Preview campaign recipients

Authorizations

Authorization
string
header
required

The id_token from POST /auth/v1/signin, sent as Authorization: Bearer <id_token>. Not the access_token — that one does not carry the identity Cloud Chat authorizes on.

Headers

cloudchat-instance
integer
required

Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. The API overview explains how instances work, how to find yours, and the errors a wrong or missing value produces.

Example:

1

Path Parameters

accountId
integer
required

Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the cloudchat-instance header — the two travel together. Account numbers are only unique within an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.

Example:

1

Body

application/json

An audience to resolve, and the channel to measure it in.

channel
enum<string>
required

What counts as reachable: a phone number for whatsapp, an e-mail address for email, a widget identifier for widget. Measure the channel the campaign will really use, or the number will not match when you create it.

Available options:
whatsapp,
email,
widget
Example:

"whatsapp"

audience
object[]
required

Whose reach to count. At most 50 entries; more is refused rather than silently truncated.

Response

The size of the audience, and how much of it this channel reaches.

How big an audience is, before and after the reachability check for a channel.

total
integer
required

Every contact the audience resolves to, counted once each, before any delivery check.

Example:

1240

reachable
integer
required

How many of those the channel can actually be delivered to. This is the number the create endpoint expects in confirm_recipients — never total.

Example:

1187