Preview an audience
/v1/projects/{project}/broadcasts/preview in the Broadcasts API.
Sizes a broadcast without sending it. The dashboard shows this before the confirm button, and an API caller needs the same safety rail.
curl "https://api.subscriby.net/v1/projects/$PROJECT_ID/broadcasts/preview?audience=customer&plan_id=$PLAN_ID" \ -H "Authorization: Bearer $SUBSCRIBY_TOKEN"The preview accepts the same audience, pass_window_id, plan_id and expiring_within_days as the send, and applies them identically, segments, plan narrowing and recipient rules alike, so a preview and the send it precedes can never describe different audiences. The fields answer the same as the send's, minus status.
Requires ability
The token must hold this ability, or the call is refused with 403.
MCP tool
Runs the same action from an agent, behind the same ability.
Authorization
bearerToken A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.
In: header
Path Parameters
The project, resolved by the route binder.
uuidQuery Parameters
The segment to size: all (the default), customer, trialing, lead, churned, expiring_soon, cancelled_still_active, paused, trialing_cardless, all_pass_holders, all_pass_holders_not_in_queue, pass_holders or pass_holders_not_in_queue. An unknown value is 422 with reason: unknown_audience and the supported list.
"all"The access window for pass_holders and pass_holders_not_in_queue; ignored by every other segment.
uuidNarrow the segment to members whose subscription is on this plan. Refused for lead and the pass segments with reason: plan_filter_unsupported; a plan of another project is reason: unknown_plan.
uuidThe horizon expiring_soon counts within, 1 to 90; a value outside the range clamps. Defaults to 7. Read by no other segment.
7Responses
200OKapplication/json
The recipient count and ETA for the segment as described.
401UnauthorizedAUTHENTICATION_REQUIREDapplication/json
The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).
403ForbiddenTOKEN_MISSING_ABILITYapplication/json
The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.
404Not foundRESOURCE_NOT_FOUNDapplication/json
An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
422Validation failedVALIDATION_FAILEDapplication/json
With error.context.reason of unknown_audience (the context also lists supported values), plan_filter_unsupported or unknown_plan.
429Too many requestsRATE_LIMITEDapplication/json
The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.
How is this guide?
Last updated on