> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cloudhumans.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Preview campaign recipients
> Resolve an audience and count it, without creating anything. Run this before creating a campaign: the `reachable` it returns is what the create endpoint expects in `confirm_recipients`, and any other value is refused with 409.
Measure the channel the campaign will really use. The create endpoint takes no channel — it follows from the inbox, or from the e-mail sender — so previewing one channel and creating in another gives two different numbers.
On `whatsapp` only contacts with a phone number count: a contact you can otherwise message through a Meta business-scoped id does not receive campaigns. On `email` the figure is an estimate rather than a promise, because the dispatcher still drops addresses that fail its format check or sit on your suppression list.
export const CloudChatYourValues = () => {
const STORAGE_KEY = "cloudchat-api-selected-account";
const CREDENTIALS_HREF = "/api-reference/cloudchat/credentials";
const [saved, setSaved] = useState(null);
const [ready, setReady] = useState(false);
useEffect(() => {
let value = null;
try {
const raw = window.localStorage.getItem(STORAGE_KEY);
if (raw) {
const parsed = JSON.parse(raw);
if (parsed && parsed.instance && parsed.account) {
value = {
instance: String(parsed.instance),
account: String(parsed.account),
name: typeof parsed.name === "string" && parsed.name ? parsed.name : null
};
}
}
} catch (error) {
value = null;
}
setSaved(value);
setReady(true);
}, []);
const shell = "not-prose rounded-xl border border-gray-200 dark:border-white/10 bg-gray-50 dark:bg-white/5 px-4 py-3 mb-6";
if (!ready || !saved) {
return
Every request below needs your cloudchat-instance header and your account
id.{" "}
Paste your token
{" "}
and they will show up here, ready to copy.
;
};
## OpenAPI
````yaml api-reference/specs/cloudchat/v1.json POST /v1/accounts/{accountId}/campaigns/preview-recipients
openapi: 3.0.1
info:
title: Cloud Chat API
version: v1
description: >-
The curated public surface of Cloud Chat. Every call needs two things: the
Bearer token from `POST /auth/v1/signin`, and the `cloudchat-instance`
header that says which Cloud Chat instance your company lives on.
If you don't know your instance value, the [Find your
credentials](/api-reference/cloudchat/credentials) page reads it out of your
own token in the browser.
servers:
- url: https://api.cloudhumans.com/cloudchat
description: Production
security:
- bearerAuth: []
tags:
- name: Canned Responses
description: >-
Canned responses — the shortcuts agents expand while replying. Each one
belongs to a single account and is identified by its short code.
- name: Conversations
description: >-
Read-only access to the conversations of an account. What you can see
follows the same rule as the dashboard: an administrator token sees every
inbox, an agent token only the inboxes it is a member of.
- name: Help Center
description: >-
Portals, categories and articles of the help center — the public FAQ your
customers read.
- name: Uploads
description: Store the images help center articles embed.
- name: Labels
description: >-
Read-only access to the labels an account has defined. A label is a tag
conversations and contacts carry; this endpoint only lists the label
definitions themselves.
- name: Inboxes
description: >-
Read-only access to the inboxes a token can see — every inbox of the
account for an administrator, only its memberships for an agent. Never
includes the channel's credentials.
- name: Agents
description: >-
Read-only access to the human and AI agents of an account. A hidden admin
(the platform's own support user) never appears, on the list or by id.
- name: Teams
description: >-
Teams group agents for assignment. Listing and reading are open to any
member; creating and updating a team, and managing its membership, require
an administrator token. A system-managed team (provisioned by the
platform) can be read like any other but never updated.
- name: Macros
description: >-
Macros bundle a sequence of actions an agent runs against a conversation
from the dashboard. This surface lets you list, read and write macro
definitions — running one is not part of the v1 contract. A macro is
either `global` (visible to the whole account) or `personal` (visible only
to its author); an agent token can only create personal macros.
- name: Automation Rules
description: >-
Read-only access to the account's automation rules — administrator only.
An agent token gets a 403 on every operation in this group.
- name: Availability Reasons
description: >-
The reasons an agent can go `busy` for, configured per account. Listing is
open to any member; creating, updating and deleting require an
administrator token. Deleting is a soft delete — the reason disappears
from listings but agents' past availability history keeps referencing it.
- name: Native Attribute Requirements
description: >-
Which native conversation attributes (priority, assignee, tag, team) the
account requires agents to fill before resolving a conversation. Listing
is open to any member; requiring and un-requiring need an administrator
token. Deleting a requirement is reversible — require the same key again
to restore it.
- name: Campaigns
description: Check who a campaign would reach, send it, and read the result back.
paths:
/v1/accounts/{accountId}/campaigns/preview-recipients:
parameters:
- $ref: '#/components/parameters/CloudChatInstance'
- $ref: '#/components/parameters/AccountId'
post:
tags:
- Campaigns
summary: Preview campaign recipients
description: >-
Resolve an audience and count it, without creating anything. Run this
before creating a campaign: the `reachable` it returns is what the
create endpoint expects in `confirm_recipients`, and any other value is
refused with 409.
Measure the channel the campaign will really use. The create endpoint
takes no channel — it follows from the inbox, or from the e-mail sender
— so previewing one channel and creating in another gives two different
numbers.
On `whatsapp` only contacts with a phone number count: a contact you can
otherwise message through a Meta business-scoped id does not receive
campaigns. On `email` the figure is an estimate rather than a promise,
because the dispatcher still drops addresses that fail its format check
or sit on your suppression list.
operationId: previewCampaignRecipients
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignPreviewRequest'
responses:
'200':
description: The size of the audience, and how much of it this channel reaches.
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignReach'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/CampaignForbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
description: >-
The request was refused. `details[].code` says why: `invalid` for a
`channel` outside the three values, `blank` for a missing audience,
`invalid_shape` when the audience is not a list of objects,
`unsupported_type` for an audience that is not a label,
`too_many_entries` above 50, and `cap_exceeded` when the audience is
larger than your account may put in one campaign — the message
carries the current ceiling.
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
'429':
$ref: '#/components/responses/CampaignTooManyRequests'
'500':
$ref: '#/components/responses/InternalError'
components:
parameters:
CloudChatInstance:
name: cloudchat-instance
in: header
required: true
description: >-
Your Cloud Chat instance ID — an integer, fixed for your company, told
at onboarding. [The API
overview](/api-reference/cloudchat/overview#two-headers-every-call)
explains how instances work, how to find yours, and the errors a wrong
or missing value produces.
schema:
type: integer
example: 1
AccountId:
name: accountId
in: path
required: true
description: >-
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.
schema:
type: integer
example: 1
schemas:
CampaignPreviewRequest:
type: object
description: An audience to resolve, and the channel to measure it in.
required:
- channel
- audience
properties:
channel:
type: string
enum:
- whatsapp
- email
- widget
description: >-
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.
example: whatsapp
audience:
type: array
description: >-
Whose reach to count. At most 50 entries; more is refused rather
than silently truncated.
items:
$ref: '#/components/schemas/CampaignAudienceEntry'
CampaignReach:
type: object
description: >-
How big an audience is, before and after the reachability check for a
channel.
required:
- total
- reachable
properties:
total:
type: integer
description: >-
Every contact the audience resolves to, counted once each, before
any delivery check.
example: 1240
reachable:
type: integer
description: >-
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
ValidationError:
type: object
description: A `validation_failed` error, which carries `details`.
required:
- error
properties:
error:
type: object
required:
- code
- message
- details
properties:
code:
type: string
enum:
- validation_failed
example: validation_failed
message:
type: string
description: >-
Localized to the account's language, like every other envelope
message.
example: The request payload is invalid.
details:
type: array
description: >-
One entry per rejected field. Unlike the envelope message above,
the texts come from the model layer and are in English in
practice (the model layer ships no translations) — match on code
and field, never on the text.
items:
type: object
required:
- field
- code
- message
properties:
field:
type: string
description: >-
Which request field the rule was about — `short_code` or
`content`. A rule that is not tied to either is reported
as `base`, so treat `base` as "the payload as a whole"
rather than a field you can highlight.
enum:
- short_code
- content
- base
example: short_code
code:
type: string
description: >-
Which rule it broke — `blank` for a missing or empty
value, `taken` for a `short_code` already used on the
account.
example: taken
message:
type: string
example: has already been taken
CampaignAudienceEntry:
type: object
description: >-
One entry of a campaign audience. Entries add up: the campaign targets
the union of their contacts, each counted once.
required:
- type
- id
properties:
type:
type: string
enum:
- Label
description: >-
Only `Label` is accepted. Cloud Chat also builds audiences from
saved filters and from uploaded files; neither is available through
the API yet, and sending either is refused as `validation_failed`
naming the type.
example: Label
id:
type: integer
description: >-
The label whose contacts join the audience. Take the `id` from the
label listing — the title is not accepted here.
example: 20010
Error:
type: object
description: The error envelope every Cloud Chat API response uses.
required:
- error
properties:
error:
type: object
required:
- code
- message
properties:
code:
type: string
description: >-
The stable, machine-readable reason. Branch on this, never on
`message`.
enum:
- unauthorized
- forbidden
- not_found
- validation_failed
- bad_request
- internal_error
example: not_found
message:
type: string
description: >-
The reason in words, localized to your account's language
(English, Spanish or Brazilian Portuguese; English when the
account is set to anything else). Wording changes with the
account and between releases, so never match on it.
Two cases stay in English whatever the account is set to:
`unauthorized`, decided before any account is known, and the
account-level `not_found`, which must not reveal the account's
language.
example: Resource could not be found.
details:
type: array
description: >-
Present on some rejections — a 400 for a refused query parameter
or upload mode, for example. One entry per offending field,
localized to the account's language like `message` — match on
`code` and `field`, never on the text.
items:
type: object
required:
- field
- code
- message
properties:
field:
type: string
description: Which request field the rule was about.
code:
type: string
description: Stable, machine-readable reason.
message:
type: string
description: The rule in words.
GatewayError:
type: object
description: >-
Rejected by the gateway before Cloud Chat saw it, so it does not use the
`error` envelope.
required:
- message
properties:
message:
type: string
example: API rate limit exceeded
request_id:
type: string
description: Gateway request id. Quote it when reporting a problem.
example: f3f7567638d4b65a8003057d0c77d275
responses:
BadRequest:
description: >-
The request itself is malformed, before any value is validated:
- a body that isn't valid JSON, or one with no `canned_response`
wrapper,
- a `canned_response` that isn't an object (`{"canned_response":
"text"}`),
- `page`, `per_page`, `search` or `sort` sent as an array or a nested
object (`?page[]=1`, `?sort[x]=y`) instead of a plain value,
- **the `cloudchat-instance` header missing or holding a value we don't
route,**
- an `accountId` that is not a number — including the literal
`{accountId}` that some API clients send when the argument is left
unset. This one answers with the normal envelope and `error.details`
naming `accountId`, and it is deliberately **not** a 404: a 404 would
mean the account cannot be reached, while this means the value was never
an account id at all, so re-read the argument instead of trying other
numbers.
**Two different shapes answer with 400, and the difference will bite you
on day one.** That last case is rejected before the request reaches the
API, so `error` is a plain **string** instead of the usual object:
```json
{ "error": "" }
```
Every other 400 uses the normal envelope, where `error` is an object
with `code` and `message`. Reading `error.code` without checking the
type first throws on the missing-header case — which is the most likely
400 of your first integration. Check `typeof error === "string"` first,
or read `error?.code` defensively.
A 400 always means fix the request shape; it never means a value was
rejected. Rejected values are 422.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: bad_request
message: The request is malformed.
Unauthorized:
description: >-
No Bearer token, or one that is expired, malformed, or not a Cognito
token. Sign in again for a fresh `id_token`.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: unauthorized
message: >-
Authentication is required. Send a valid Bearer token in the
Authorization header.
CampaignForbidden:
description: >-
Refused. Either the identity lacks the role these operations need —
creating a campaign, reading one back and both discovery listings all
require an administrator, a supervisor or a CX engineer, and an agent is
refused — or the account is suspended, which closes it even to its own
members until it is reactivated.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: forbidden
message: You do not have permission to perform this action.
NotFound:
description: >-
The resource is not there for you. Three situations answer with this
code, and the first two apply to **every** endpoint — the account is
resolved before anything else runs, so a list or a create fails this way
too:
- the account does not exist on this instance,
- the account exists but your token has no membership on it,
- on an endpoint that names one, the resource it names (a canned
response, a portal, an article) does not exist where the path says it
does.
The first two are deliberately indistinguishable — same status, same
body, and the message stays in English in both, since translating it
would reveal the account's configured language. So you cannot use this
endpoint to find out which account ids exist. The third case is
localized like every other error, which is safe because you only reach
it once membership is established.
Either way a 404 is not worth retrying. Check the `accountId`, the
`cloudchat-instance` value, and that your user is a member of the
account.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: not_found
message: Resource could not be found.
CampaignTooManyRequests:
description: >-
Rate limited, and nothing was created. Two ceilings apply and they
answer differently: the gateway stops the request before it reaches the
API and answers `{ "message": ... }`, while Cloud Chat applies its own
ceiling to campaign previews and campaign creation per account and
answers the usual `{ "error": ... }` envelope with code `rate_limited`.
Don't hardcode either limit — read it from the response. `Retry-After`
says how many seconds to wait, and `ratelimit-limit`,
`ratelimit-remaining` and `ratelimit-reset` carry the current values.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/GatewayError'
- $ref: '#/components/schemas/Error'
example:
error:
code: rate_limited
message: Too many requests. Try again in a moment.
InternalError:
description: >-
Something failed on our side. The response never carries the underlying
error, but it is reported to our monitoring automatically — no need to
file anything for a one-off.
Retrying is reasonable, with one caveat on `POST`: a 500 does not prove
the write did not happen, so a retry can come back `422` with
`short_code` already taken. That 422 means the first attempt succeeded —
list the account and confirm before treating it as a failure.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: internal_error
message: An unexpected error occurred. Please try again later.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
The `id_token` from `POST /auth/v1/signin`, sent as `Authorization:
Bearer `. Not the `access_token` — that one does not carry the
identity Cloud Chat authorizes on.
````