Skip to content

Unsubscribe from newsletter or push channel

POST
/cms/channel/{channel_id}/unsubscribe

Unsubscribe an email from a given newsletter or push channel. For email channels, you must be authenticated. For push channels, you can either be authenticated to unsubscribe all the devices of the user, or you can be anonymous and provide a push token to unsubscribe a specific device.

channel_id
required
integer
object
pushSignature

Push token to unsubscribe (required if called anonymously for push channels)

string
nullable
email

Email address to unsubscribe. Only allowed when both authenticated as an admin API client and not authenticated as a user.

string
nullable

Unsubscription result

object
error
boolean

Bad Request, e.g. missing token when called anonymously

Forbidden