Skip to content

Unsubscribes

Manage user consent and opt-out preferences.

Adding Unsubscribe Links to Emails:

Include the {{unsubscribe}} placeholder in your email HTML or text:

<p><a href="{{unsubscribe}}">Unsubscribe</a></p>

MailerLogic automatically:

  • Replaces {{unsubscribe}} with a unique, secure URL per recipient
  • Adds RFC 8058 List-Unsubscribe headers for Gmail/Outlook one-click
  • Tracks unsubscribes per domain
  • Enforces unsubscribe preferences on future sends

User-Initiated Opt-Outs:

  • Unsubscribe link clicks in emails (via {{unsubscribe}})
  • One-click unsubscribe in email clients (Gmail, Outlook)
  • API-based unsubscribe requests
  • Domain-specific or global unsubscribe preferences

Unsubscribe Scope:

  • Global: User opts out from ALL your domains
  • Domain-specific: User opts out from a specific domain only

Key Features:

  • Add emails to unsubscribe list
  • Remove (re-subscribe) emails
  • List all unsubscribed emails with filtering
  • Automatic enforcement during email sending

Ensures compliance with CAN-SPAM, GDPR, and other anti-spam regulations.

Operations

List unsubscribes

Request

Retrieve your unsubscribe list with filtering and search capabilities.

Use this to:

  • Monitor user opt-out trends
  • Export unsubscribe lists for compliance
  • Audit unsubscribe sources (API, link clicks, manual)
  • Filter by domain or view all unsubscribes
  • Track consent management across your domains

Complete unsubscribe lifecycle management with comprehensive analytics and compliance reporting.

Each unsubscribe includes a scope field indicating whether it's global (all domains) or domain-specific.

Note: For system-managed suppressions (bounces, complaints), see the /api/v1/customer/suppressions endpoints.

Security
ApiKeyAuth
Query
pageinteger, >= 1
Default:1
limitinteger, [ 1 .. 100 ]
Default:50
searchstring

Search by email address (partial match)

domain_idstring, (uuid)

Filter by specific domain (omit to see all unsubscribes)

from_datestring, (date)

Filter from date (YYYY-MM-DD)

to_datestring, (date)

Filter to date (YYYY-MM-DD)

curl -i -X GET \
  'https://api.mailerlogic.net/api/customer/unsubscribes?page=1&limit=50&search=string&domain_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&from_date=2019-08-24&to_date=2019-08-24' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Unsubscribes retrieved successfully

Bodyapplication/json
unsubscribesArray of objects(Unsubscribe)
paginationobject(Pagination)
Response
{
  "unsubscribes": [
    { … },
    { … }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 25,
    "pages": 1
  }
}