Estimate reach and cost
POST/broadcasts/:id/estimate
Checks the whole campaign and works out who it would reach right now: how many contacts, how many are left out and why, the recipient cap, the plan quota, the number's messaging limit at Meta and the estimated cost per country. It changes nothing.
With an API key limited to some numbers, the estimate only counts the audience contacts that have a conversation on those numbers.
Request
Responses
- 200
- 401
- 402
- 403
- 404
- 422
- 429
Record found.
Missing, malformed, unknown or revoked token (authentication), or a suspended
account (tenant_inactive).
No entitlement (payment_required). The body carries the reason in reason and the
way out in action: what to do (kind) and the dashboard page where it is done (url).
The resource does not belong to your account (forbidden), or the path is on the
mirror's block list (forbidden_endpoint), or your API key is limited to some numbers and
the operation covers the whole account (forbidden).
Resource does not exist (not_found).
The campaign is not ready: broadcast_incomplete, template_not_found, template_not_approved, template_not_supported, variable_unmapped (with issues), audience_invalid, audience_filter_invalid or audience_too_complex.
Rate limit exceeded (rate_limit).
Response Headers
Seconds to wait before retrying.
Which rate limit category applied — send, media or default.
Which bucket the other headers describe — key (the API key), session (the dashboard) or account (the account ceiling).
Request ceiling for this category in the current window.
Requests left in the current window.