Subscriptions
Global Unsubscribe
Opt an address out of all communications from the Prezly account.
Personal tokens are not supported for this endpoint. Use an integration API key. Your account must also have access to the requested data. Authentication
POST
Personal access tokens are not supported for this endpoint. Use an integration API key with the required permissions.
API_keyheader
AuthorizationBearer <token>Bearer authentication using an integration API key, or a personal access token only where the operation explicitly supports it. Every listed personal-token scope is required; owner permissions and newsroom access still apply.
application/json- body
Either
email_address?stringRequired if utm.utm_id is not provided.
locale?stringurl?stringcomment?stringreason?stringValue in
"unknown""unwanted""spam""never_signed_up""other"utm?OK
application/json- response
subscription?curl -X POST 'https://api.prezly.com/v2/unsubscribe' \ -H 'Content-Type: application/json' \ -d '{}'Example Response200
{ "subscription": { "id": "string", "email_address": "string", "first_name": "string", "last_name": "string", "is_demo": true, "contacts": [ { "id": 0, "contact_type": "person", "display_name": "string", "function_name": "string", "avatar_url": "http://example.com", "is_deleted": true, "links": { "api": "http://example.com", "view": "http://example.com" } } ] }}