Record an opt-out

POST 
/contacts/:id/opt-out

Removes consent and puts the contact's phone and BSUID on the suppression list. Fires contact.opted_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

Record found.

401

Missing, malformed, unknown or revoked token (authentication), or a suspended account (tenant_inactive).

402

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).

404

Resource does not exist (not_found).

422

Payload failed validation (invalid_request, detailed in issues) or was rejected by Meta (meta_error, with the original body in meta).

429

Rate limit exceeded (rate_limit).

Response Headers

Retry-After

Seconds to wait before retrying.

X-RateLimit-Category

Which rate limit category applied — send, media or default.

X-RateLimit-Scope

Which bucket the other headers describe — key (the API key), session (the dashboard) or account (the account ceiling).

X-RateLimit-Limit

Request ceiling for this category in the current window.

X-RateLimit-Remaining

Requests left in the current window.