HomeKnowledge BaseAPI Reference
API ReferenceSubmit a Ticket
API Reference
API ReferenceSubmit a Ticket

Unsubscribe Contact

post
https://api.campaignrefinery.com/rest/contacts/unsubscribe

Unsubscribes a contact identified by email or id (contact UUID). At least one is required; id takes precedence when both are supplied. Unsubscribing an already-unsubscribed contact succeeds. Pass domain to target a sub-account in the same billing group.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null

Required if id is omitted. The contact's email address.

string | null

Required if email is omitted. Contact UUID. Takes precedence over email when both are supplied.

string | null

Optional. Domain of a sub-account in the same billing group; the request targets that sub-account.

Responses

401

Missing or invalid bearer token.

Updated 4 days ago

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

Updated 4 days ago