Subscribe to multiple newsletter or push channels

POST

/cms/channel/subscribe

• The API server for the WhiteBeard News Suite
• Local development server for the WhiteBeard News Suite
• Local worker for the WhiteBeard News Suite

Subscribe an email to one or more newsletter or push channels. If the user is logged in (Token is sent), the email parameter is ignored, and no activation email is sent. For push channels, the push subscription details must be provided.

Authorizations

• ApiKeyAuth
• CustomerAuth
• DeprecatedCustomerAuth

Request Body^required

One of:

object

object

channel_ids

Array<integer>

email

Email address to subscribe. If the user is logged in, this parameter is ignored.

string

nullable

sendActivation

Set to true to send activation email. Otherwise, the user is activated immediately. If the user is logged in, this parameter is ignored.

boolean

nullable

last_login_country

string

nullable

source

Optional arbitrary key-value metadata about the subscription source (e.g. {“page”: “homepage”, “campaign”: “summer2026”}). Stored as JSON on the newsletter record.

object

key

additional properties

string

object

object

channel_ids

Array<integer>

pushSignature

Push subscription URL or token

string

clientVersion

Client application version

string

clientOS

Client operating system

string

clientOSVersion

Client operating system version

string

userAgent

User agent string

string

deviceId

Device identifier that you can uniquely generate or use from the user devices

string

nullable

Responses

200

Subscription result

object

error

boolean