Mailfully logo

Add a suppression

POSThttps://api.mailfully.com/v1/suppressions

Manually suppress an address. The email is lowercased and trimmed before it is stored; the format is not validated. Adding the same address twice is safe: a new address returns 201, and an existing one returns 200 with the existing suppression. Manual adds are always stored with reason manual and source dashboard. Needs the manage:suppressions scope, which can be minted onto a live API key.

Loading code example
Loading code example

Authorizations

Authorizationstringheaderrequired

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

Body

emailstringrequired

Address to suppress; normalized to lowercase. Format is not validated.

Response

application/json

The address was already suppressed; the existing suppression is returned.

idstringrequired

The suppression id (a bare ULID, no prefix).

emailstringrequired

The suppressed address, canonical lowercase.

reasonstringrequired

One of manual, hard_bounce, or complaint.

sourcestringrequired

One of dashboard or ses_notification.

created_atstring<date-time>required