Skip to main content
POST
/
v2
/
loyalty_emails
/
unsubscribes
cURL
curl --request POST \
  --url https://api.loyaltylion.com/v2/loyalty_emails/unsubscribes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com"
}
'
{
  "error": {
    "message": "<string>",
    "details": {}
  }
}
Add a new email to the LoyaltyLion email unsubscribe list. Emails on this list will not receive any emails from LoyaltyLion. Returns a 201 status code if the email was added to the list, or 200 if it was already on the list.

Authorizations

​
Authorization
string
header
required

An API key linked to a Program in LoyaltyLion, with a set of permissions (scopes). API keys can be created manually, or acquired through an OAuth2 flow. The API key should be provided as a Bearer token in the Authorization header

Body

application/json

Body

​
email
string<email>
required

Email address of the customer to unsubscribe

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Response

200