Subscribe to a newsletter or push channel
POST/cms/channel/{channel_id}/subscribe
Subscribe an customer to a newsletter or push channel. 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
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”object
Email address to subscribe. If the user is logged in, this parameter is ignored.
Set to true to send activation email. Otherwise, the user is activated immediately. If the user is logged in, this parameter is ignored.
Optional arbitrary key-value metadata about the subscription source (e.g. {“page”: “homepage”, “campaign”: “summer2026”}). Stored as JSON on the newsletter record.
object
object
Push subscription URL or token
Client application version
Client operating system
Client operating system version
User agent string
Device identifier that you can uniquely generate or use from the user devices
Responses
Section titled “Responses”Subscription result