Skip to contentDevelopersPrezly website
Subscriptions

Update Global Unsubscribe Details

Add feedback to an existing account-wide unsubscribe event.

Personal tokens are not supported for this endpoint. Use an integration API key. Your account must also have access to the requested data. Authentication

Read the guide

PATCH
/unsubscribe/{id}

Personal access tokens are not supported for this endpoint. Use an integration API key with the required permissions.

Authorization

API_key
headerAuthorizationBearer <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.

Path Parameters

id*string

Email Subscription UUID

Request Body

application/json
  1. body
locale?string
url?string
comment?string
reason?string
Value in"unknown""unwanted""spam""never_signed_up""other"

Response Body

OK

application/json
  1. response
subscription?
Example Request
curl -X PATCH 'https://api.prezly.com/v2/unsubscribe/string' \  -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"        }      }    ]  }}