Skip to main content
POST
/
api
/
v2
/
external
/
email-preferences
/
unsubscribe
Unsubscribe From Emails
curl --request POST \
  --url https://api.lyceum.technology/api/v2/external/email-preferences/unsubscribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "categories": [
    "all"
  ]
}
'
{}

Authorizations

​
Authorization
string
header
required

Pass an API key (prefixed lk_) or a JWT access token as a bearer token. Generate API keys in the dashboard at https://dashboard.lyceum.technology/api-keys.

Body

application/json

Request to unsubscribe from specific email categories.

​
email
string<email>
required
​
categories
string[]

Response

Successful Response

The response is of type Response Unsubscribe From Emails Api V2 External Email Preferences Unsubscribe Post · object.