# Add to unsubscribe list

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.

Endpoint: POST /api/customer/unsubscribes
Version: 1.0.0
Security: ApiKeyAuth

## Request fields (application/json):

  - `email` (string, required)
    Email address to unsubscribe
    Example: "user@example.com"

  - `domain_id` (string)
    Optional - Specify domain ID for domain-specific unsubscribe. Omit for global unsubscribe.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `reason` (string)
    Optional reason for unsubscribe
    Example: "User requested removal"

## Response 201 fields (application/json):

  - `message` (string)
    Example: "Email unsubscribed successfully"

  - `unsubscribe` (object)

  - `unsubscribe.id` (string)
    Unique unsubscribe record ID

  - `unsubscribe.email` (string)
    Unsubscribed email address

  - `unsubscribe.source` (string)
    How the unsubscribe occurred
    Enum: "link", "one-click", "api", "manual"

  - `unsubscribe.reason` (string)
    Reason for unsubscribe

  - `unsubscribe.created_at` (string)
    When the unsubscribe occurred

## Response 400 fields (application/json):

  - `error` (string)
    Example: "Invalid email address"

  - `message` (string)

## Response 401 fields (application/json):

  - `error` (string)
    Error code or message

## Response 409 fields (application/json):

  - `error` (string)
    Example: "Already unsubscribed"

  - `message` (string)