Skip to main content
POST
/
api
/
v1
/
suppressions
Add an email to the suppression list
curl --request POST \
  --url https://api.railmail.app/api/v1/suppressions \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "email": "jsmith@example.com",
  "ipAddress": "<string>"
}
'
{
  "email": "jsmith@example.com",
  "suppressed": true,
  "reason": "<string>",
  "suppressedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-Key
string
header
required

Project-scoped API key, format rm_(live|test)_... . May also be sent as Authorization: Bearer rm_....

Body

application/json
​
email
string<email>
required
​
reason
enum<string> | null
Available options:
GLOBAL_UNSUBSCRIBE,
SPAM_COMPLAINT,
HARD_BOUNCE
​
ipAddress
string | null

Response

Suppression added

​
email
string<email>
​
suppressed
boolean
​
reason
string | null
​
suppressedAt
string<date-time> | null