Manage newsletter subscriptions for your site. A newsletter subscription links an email address to your site and tracks consent information (source, IP, URL, text, type) for compliance purposes.

Each subscription is uniquely identified by the combination of email and site_id.

The Newsletter object

Field	Type	Description
`email`	string	Subscriber's email address
`first_name`	string \| null	Subscriber's first name
`last_name`	string \| null	Subscriber's last name
`postal_code`	string \| null	Subscriber's postal code
`site_id`	integer	The site this subscription belongs to
`source`	string	How the subscription was created (`0` = Web, `1` = Phone, `2` = Mail, `3` = Other)
`lists`	string \| null	Comma-separated list identifiers the subscriber belongs to
`consent_url`	string	URL where consent was given
`consent_ip`	string	IP address recorded at consent time (set by server)
`consent_text`	string	Consent text shown to the subscriber
`consent_type`	string	Type of consent obtained
`created_at`	string \| null	ISO 8601 timestamp
`updated_at`	string \| null	ISO 8601 timestamp

Webhook events

Newsletter actions fire the following webhook events:

newsletter.created — when a subscription is created
newsletter.updated — when a subscription is updated
newsletter.deleted — when a subscription is deleted

Available endpoints

Method	Endpoint	Description
POST	`/newsletter`	Create a newsletter subscription
GET	`/newsletter/{email}`	Get a newsletter subscription
PUT	`/newsletter/{email}`	Update a newsletter subscription
DELETE	`/newsletter/{email}`	Delete a newsletter subscription