Suppression

List allowlist or look up an address

Requires scope: read. Three answers from one route. With ?address=, the suppression status of that address. With ?view=suppressed, which of your own recent recipients are suppressed for you, and why (up to 500, in one page; addresses are stored hashed, so the list itself cannot be browsed). Without either, the workspace allowlist (paginated).

get/v1/suppression

Request

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

Query parameters

addressstring email

Look up suppression status for this address instead of listing the allowlist.

view'suppressed'

suppressed: list which of your own recent recipients are suppressed for you, and why, instead of the allowlist.

limitinteger

Page size (1–100).

cursorstring

Opaque cursor from a previous page's next_cursor.

Response

A suppression lookup (when address is set), your suppressed recipients (when view=suppressed), or a page of allowlist entries.

OR
OR

Changes

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