Suppression

Add an allowlist entry

Requires scope: manage. Attests that a recipient consents, overriding non-hard-bounce suppression for that address.

post/v1/suppression/allow

Request

  • Base URL: https://api.mails.ai
  • URL: https://api.mails.ai/v1/suppression/allow
  • Auth: HTTP bearer

Request body

addressstring email required

The recipient to send to again despite a complaint or unsubscribe; a hard bounce is not lifted. Matched in lowercase, without any +tag and, for gmail.com and googlemail.com, without dots before the @, so one entry covers each such spelling.

attestationstring required

Your statement that the recipient agreed to receive your mail, 20 to 2,000 characters. It is stored with the entry and returned with it.

Response

The created allowlist entry.

idstring required

Allowlist entry id (sup_…); revoke it with DELETE /v1/suppression/allow/{id}.

addressstring email required

The address the entry covers. The create response echoes it as sent; the list shows it as matched: lowercase, without a +tag, and for Gmail without dots before the @.

attestationstring required

Your statement that the recipient agreed to receive your mail, as given when the entry was added.

revoked_atstring date-time

When the entry was revoked. Absent while it is active; a revoked entry stays in the list but lifts nothing.

created_atstring date-time required

When the entry was added (UTC).

Changes

No recorded changes to this operation across all 1 revision of this API.