Mailfullydocs

Add a suppression

Manually suppress an address. The email is normalized (trim().toLowerCase()) before storage; the format is not validated.

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

Manually suppress an address. The email is normalized (trim().toLowerCase()) before storage; the format is not validated. The operation is idempotent on (org, email): a new row returns 201, an existing address returns 200 with the existing row. Manual adds are always stored with reason manual and source dashboard. Requires the manage:suppressions scope, which is a dashboard-session scope and cannot be granted to API keys today: every mf_ API key receives 403. Call this endpoint with a dashboard session token (owner, admin, or member).

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 row 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