HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

User / Revoke marketing consent

Revoke a single user's marketing consent. Records an admin-initiated entry in the consent
audit log and an entry in the backend Actions log, attributed to the API token's admin.
Use when acting on a GDPR opt-out request received outside the app.

Idempotent: calling on a user who is already opted out returns 202, refreshes the
'receive news and promotions' updated-at timestamp, and records a new entry in the
Actions log. The consent audit log only gains entries for consents whose state actually
changes.

Partner-scoped tokens: when a partner-scoped token targets a user outside the partner's
visibility, the response is 403 (consistent with other user-action endpoints) — the
user-edit ability is denied because the token's admin cannot act on the target user.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

the user ID to revoke marketing consent for

Body Params
string
length ≤ 500

Optional note kept in the action audit log (e.g. ticket reference, support case ID, requester name).

Responses
202

Action accepted

Language
Credentials
Bearer
API Token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json