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

customer
object
required
id
number
required

The LoyaltyLion ID of the customer

email
string
required

The email address of the customer

Example

Example
{
  "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"
      }
    }
  }
}