Check whether an email is suppressed

curl --request GET \
  --url https://api.railmail.app/api/v1/suppressions/{email} \
  --header 'X-API-Key: <api-key>'

{
  "email": "jsmith@example.com",
  "suppressed": true,
  "reason": "<string>",
  "suppressedAt": "2023-11-07T05:31:56Z"
}

GET

api

suppressions

{email}

Check whether an email is suppressed

curl --request GET \
  --url https://api.railmail.app/api/v1/suppressions/{email} \
  --header 'X-API-Key: <api-key>'

{
  "email": "jsmith@example.com",
  "suppressed": true,
  "reason": "<string>",
  "suppressedAt": "2023-11-07T05:31:56Z"
}

X-API-Key

string

header

required

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

string<email>

required

URL-encoded subscriber email.

Suppression status

string<email>

suppressed

boolean

reason

string | null

suppressedAt

string<date-time> | null