Skip to main content
POST
/
suppressions
Add email(s) to suppression list
curl --request POST \
  --url https://api.lettermint.co/v1/suppressions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "jsmith@example.com",
  "emails": [
    "jsmith@example.com"
  ],
  "reason": "spam_complaint",
  "scope": "team",
  "route_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "message": "<string>",
  "data": {
    "created": [
      "<any>"
    ],
    "skipped": [
      "<any>"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

StoreSuppressionData

​
reason
enum<string>
required
Available options:
spam_complaint,
hard_bounce,
unsubscribe,
manual
​
scope
enum<string>
required
Available options:
team,
project,
route
​
email
string<email> | null
Maximum length: 255
​
emails
string<email>[] | null
Required array length: 1 - 1000 elements
​
route_id
string<uuid> | null
​
project_id
string<uuid> | null

Response

​
message
required
​
data
object
required