> ## Documentation Index
> Fetch the complete documentation index at: https://developers.loyaltylion.com/llms.txt
> Use this file to discover all available pages before exploring further.

# loyalty_emails/unsubscribe

This webhook is triggered when a customer unsubscribes from any email sent by
LoyaltyLion.

To subscribe to this webhook, your API token needs to have the
`read_unsubscribes` scope.

## Payload

<ResponseField name="customer" type="object" required>
  <Expandable title="properties" defaultOpen={true}>
    <ResponseField name="id" type="number" required={true}>
      The LoyaltyLion ID of the customer
    </ResponseField>

    <ResponseField name="email" type="string" required={true}>
      The email address of the customer
    </ResponseField>
  </Expandable>
</ResponseField>

## Example

```json Example theme={null}
{
  "id": "bff1bddb-6cd8-4c2c-9619-18744657053c",
  "topic": "loyalty_emails/unsubscribe",
  "created_at": "2018-01-01T03:00:05.000Z",
  "payload": {
    "unsubscribe": {
      "customer": {
        "id": 6936,
        "email": "sarah@example.com"
      }
    }
  }
}
```
