Skip to contentDevelopersPrezly website
Subscriptions

Newsroom Subscribe

Record a fresh subscription request and return the subscription identity.

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

Subscribe reactivates the selected newsroom subscription and clears an account-wide opt-out. Use it only for a fresh, explicit request; the returned identity does not contain subscription-status flags.

Read the guide

POST
/newsrooms/{newsroom_id}/subscribe

Directly changes the subscription; it does not send a double-opt-in confirmation email. Subscribing clears an account-wide opt-out and reactivates this newsroom subscription; other cancelled newsroom subscriptions remain cancelled. It can create or update CRM contact data when the newsroom configuration or contact payload requests it.

Personal access tokens: sites:write and contacts: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
email_address*string
locale?string
contact?

Request to create contact

url?string
comment?string

Response Body

OK

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