Schedule broadcast from saved segment

Retained legacy exception: Schedule using persisted segment membership, currently absent from V3 scheduling.

Schedule using persisted segment membership, currently absent from V3 scheduling.

Requires an enabled CDP custom segment, eligible members, a valid template and sending channel, and sufficient balance/limits. Membership is resolved when scheduling and recipient links are created then. Inspect contactCount and freqCapLimitedCount; not every member is necessarily eligible. This creates a campaign and is not guaranteed idempotent: after timeout/5xx, reconcile broadcast state before retrying.

Permissions

For API access tokens and OIDC tokens, satisfy at least one of: api, wati_integration:write, messagetemplate:write. Legacy JWTs do not use this scope check. Allowed roles: DEVELOPER, ADMINISTRATOR, EXTERNAL_ADMINISTRATOR, PARTNER_ADMINISTRATOR, AI_OPERATOR or API_TOKEN, OPERATOR or TRIAL. FLEXI_TRIAL and FLEXI_PAID are denied even with another listed role. Workspace and billing restrictions also apply. Saved-segment operations require account availability and a qualifying Pro or Business subscription. Denial can return 400 with result=false and info; scopes alone do not grant access.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Workspace ID; use the regional API host and matching workspace credential.

Body Params
string
required
length ≥ 1
string
required
length ≥ 1
date-time
required

Future timestamp with a UTC offset; prefer UTC.

string
required
length ≥ 1

CDP custom segment ID. A system-segment ObjectId is rejected.

string

Sending WhatsApp number; optional.

Responses

401

Unauthorized; a JSON body is not guaranteed.

403

Access denied by scopes, roles, workspace or billing; a JSON body is not guaranteed.

429

Rate or usage limit exceeded.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json