Create or update contacts in bulk
POST/contacts/batch
Up to 500 contacts per call, each created or updated by phone or BSUID. The answer is
200 even when rows fail: each row's outcome comes in results, in the order sent.
On an update, only filled values overwrite and tags are added. With
options.optIn, new contacts are born with consent and existing ones only get it if they
were still unknown — an opt-out is never undone. A batch fires no webhooks.
An API key limited to some numbers gets 403: this operation covers the whole base.
Request
Responses
- 200
- 401
- 402
- 403
- 404
- 422
- 429
Outcome per row.
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).
Payload failed validation (invalid_request, detailed in issues) or was
rejected by Meta (meta_error, with the original body in meta).
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.