Skip to contentDevelopersPrezly website
Subscriptions

Subscribe email address to Newsroom

Legacy subscribe endpoint with an empty 201 response. Use Newsroom Subscribe for new integrations.

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

Read the guide

Deprecated

POST
/newsrooms/{newsroom_id}/subscriptions

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
Formatemail
locale?LocaleCode

Language code (ISO 639-1 or ISO 639-2), with optional script designator (ISO 15924) and optional region code (ISO 3166-1).

Match[a-z]{2,3}(_[A-Z][a-z]{3})?(_[A-Z]{2})?
Length2 <= length
url?string

Page URL where the contact has subscribed to. For analytical purposes.

Formaturi
contact?

Request to create contact

ip_address?string
visitor_uid?string
session_uid?string

Response Body

Subscribed

Example Request
curl -X POST 'https://api.prezly.com/v2/newsrooms/string/subscriptions' \  -H 'Content-Type: application/json' \  -d '{  "email_address": "user@example.com",  "locale": "en",  "url": "http://example.com"}'
Example Response
Empty