Edit a contact
PATCH/contacts/:id
An absent field is left alone; null clears it. attributes is a patch over the
stored values, and tagIds is the complete set of tags. Consent is not edited here —
use opt-in and opt-out.
With an API key limited to some numbers, a contact with no conversation on those numbers answers 404, like one that does not exist.
Request
Responses
- 200
- 401
- 402
- 404
- 409
- 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).
Resource does not exist (not_found).
contact_exists (the phone or BSUID already belongs to another contact, with contactId) or contact_limit_reached (the plan reached its contact cap, with limit and plan).
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.