Skip to main content
POST
/
contacts
/
suppressed
Add an email or domain to the suppression list
curl --request POST \
  --url https://api.getfernand.com/contacts/suppressed \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "email": "galvin@hooli.com"
}
'
{
  "id": 123,
  "email": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "blocked": 123,
  "is_common": true
}

Documentation Index

Fetch the complete documentation index at: https://developers.getfernand.com/llms.txt

Use this file to discover all available pages before exploring further.

Suppresses an email address or entire domain to prevent sending emails to them. For domain-level suppression, use the pattern ”*@domain.com” which will suppress all emails from that domain and consolidate existing suppressions for that domain. The endpoint validates the email format and prevents duplicate suppressions.

Authorizations

​
X-API-Key
string
header
required

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed by using the HTTP Header X-API-Key.

Body

application/json
​
email
string<email>
required

Email address to suppress, or domain pattern "*@domain.com" to suppress entire domain.

Example:

"galvin@hooli.com"

Response

Email or domain suppressed successfully.

​
id
integer<int64>

Unique identifier for the suppression record

​
email
string

Suppressed email or domain pattern

​
created
string<date-time>

Timestamp when the suppression was created (UTC)

​
blocked
integer

Number of times emails to this address/domain have been blocked

​
is_common
boolean

Whether this is a common webmail domain (true) or a company domain (false)