Skip to content

Add to unsubscribe list

Request

Add an email address to your unsubscribe list for user consent management.

Unsubscribe Scope:

  • Global: Omit domain_id to unsubscribe from ALL your domains
  • Domain-specific: Include domain_id to unsubscribe from a specific domain only

Use cases:

  • Processing manual unsubscribe requests (phone, email, support tickets)
  • Honoring opt-out preferences from other channels
  • Importing unsubscribe lists from other platforms
  • Domain-specific opt-outs for users who want targeted unsubscribes
  • Proactive consent management

Note: Unsubscribe links in emails are handled automatically. Use this endpoint for opt-outs from other channels.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
emailstring, (email)required

Email address to unsubscribe

Example:"user@example.com"
domain_idstring, (uuid)

Optional - Specify domain ID for domain-specific unsubscribe. Omit for global unsubscribe.

Example:"123e4567-e89b-12d3-a456-426614174000"
reasonstring

Optional reason for unsubscribe

Example:"User requested removal"
curl -i -X POST \
  https://api.mailerlogic.net/api/customer/unsubscribes \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "email": "user@example.com",
    "domain_id": "123e4567-e89b-12d3-a456-426614174000",
    "reason": "User requested removal"
  }'

Responses

Email unsubscribed successfully

Bodyapplication/json
messagestring
Example:"Email unsubscribed successfully"
unsubscribeobject(Unsubscribe)
Response
{
  "message": "Email unsubscribed successfully",
  "unsubscribe": {
    "id": "string",
    "email": "user@example.com",
    "source": "link",
    "reason": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
}