Newsletters

Manage newsletter subscriptions and consent records for email marketing.

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

  1. Collect consent - Capture email and consent when a visitor subscribes to your newsletter
  2. Assign to lists - Organize subscribers into different mailing lists
  3. 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

MethodEndpointDescription
GET/api/v1/core/newslettersList all newsletter subscriptions
POST/api/v1/core/newslettersCreate 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

Related Endpoints