Newsletters

Overview

Newsletters track email subscription consent for marketing communications. Each record stores the subscriber's email, consent details, and which lists they've subscribed to.

How It Works

Collect consent - Capture email and consent when a visitor subscribes to your newsletter
Assign to lists - Organize subscribers into different mailing lists
Track source - Record where the subscription originated for compliance

Example: A visitor enters their email in your footer signup form. Create a newsletter record with their email, the consent URL, and assign them to your "Weekly Updates" list.

API Endpoints

Method	Endpoint	Description
`GET`	`/api/v1/core/newsletters`	List all newsletter subscriptions
`POST`	`/api/v1/core/newsletters`	Create a newsletter subscription
`GET`	`/api/v1/core/newsletters/{id}`	Get a newsletter subscription
`PUT`	`/api/v1/core/newsletters/{id}`	Update a newsletter subscription
`DELETE`	`/api/v1/core/newsletters/{id}`	Delete a newsletter subscription

Newsletter Object

Attribute	Type	Description
`id`	integer	Unique identifier for the newsletter subscription
`email`	string	Subscriber's email address
`first_name`	string	Subscriber's first name
`last_name`	string	Subscriber's last name
`source`	string	Where the subscription originated
`lists`	array	Array of mailing lists the subscriber belongs to
`consent_url`	string	URL where consent was given
`consent_ip`	string	IP address when consent was given
`consent_text`	string	Consent text shown to subscriber
`consent_type`	string	Type of consent given
`postal_code`	string	Subscriber's postal code
`created_at`	timestamp	Unix timestamp of creation
`updated_at`	timestamp	Unix timestamp of last update

Related Endpoints

List Newsletters - Retrieve newsletter subscriptions