Skip to contentDevelopersPrezly website
Subscriptions

Newsroom Unsubscribe

Opt an email address out of one newsroom’s communications.

Personal token scopes: sites:write. Your account must also have access to the requested data. Authentication

Read the guide

POST
/newsrooms/{newsroom_id}/unsubscribe

Personal access tokens: sites:write. Every listed scope is required; the token owner's permissions, feature availability and newsroom access still apply.

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

newsroom_id*string

Newsroom UUID or ID

Length1 <= length

Request Body

application/json
  1. body

Either

email_address?string

Required if utm.utm_id is not provided.

locale?string
url?string
comment?string
reason?string
Value in"unknown""unwanted""spam""never_signed_up""other"
utm?

Response Body

OK

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