Send a campaign test
POST/broadcasts/:id/test
Sends the campaign's template to one number, right away, outside the queue and the
metrics. Variables come from the contact contactId, if you send it; otherwise from the
fallback values. The campaign must be complete.
With an API key limited to some numbers, a contactId with no conversation on those numbers answers 404.
Request
Responses
- 201
- 401
- 402
- 403
- 404
- 422
- 429
Created.
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.