Skip to main content
AhaSend CLI suppressions commands let you inspect and manage blocked recipient addresses; this page explains their options. Before running the examples, log in with an API key that has the suppressions:read, suppressions:write, suppressions:delete and suppressions:wipe scopes, and replace example.com in the --domain values with a test domain in your account.

Overview

Available subcommands:
  • list - List suppressed email addresses
  • create - Create a suppression for an email address
  • check - Check if an email address is suppressed
  • delete - Delete the suppressions of an email address
  • wipe - Delete all suppressions from your account, or from one domain
Suppressions are email addresses that should not receive emails from your account. Each suppression applies to one domain: an address can have one suppression per domain, and no suppression covers every domain. Bounces and spam complaints add suppressions automatically, and unsubscribes come from the recipients themselves. Unsubscribes and spam complaints are protected suppressions. suppressions wipe keeps them. suppressions delete deletes them like any other suppression. Table, plain and CSV output show whether each suppression is protected. The commands check each email address and each --domain value before they send a request. An invalid value fails with exit code 4. An empty --domain fails too; leave the flag out instead.

List Suppressions

List suppressed email addresses, with cursor pagination. Filter by email address, domain and creation time.
--from-time and --to-time take an RFC 3339 time, such as 2026-09-01T00:00:00Z, or a relative time that counts back from now, such as 24h or 7d. Pages work as Lists and Pagination describes; replace YOUR_CURSOR with the cursor of the previous page.

Create Suppression

--expires is required. It takes a time after now: a relative time, such as 24h, 30d, 1w, 3mo or 1y, or an RFC 3339 time in the future, such as 2027-12-31T23:59:59Z. A time in the past fails before any request is sent. Without --domain, the API creates a suppression for each domain the account has at that moment. Domains you add later are not covered.
--reason holds up to 255 characters. Give your own --idempotency-key when a script may retry the command; without it, each run generates a new key.

Check Suppression

Without --domain, the command shows the address’s suppressions on every domain, up to the API’s default page of 100. With --domain, it shows only the suppression for that domain. It exits with code 0 whether or not the address is suppressed. --output json prints the API’s list of matching suppressions.

Delete Suppression

With --domain, the command deletes only the suppression for that domain. Without it, the command deletes the address’s suppressions on every domain, unsubscribes and complaints included. The command asks for confirmation first, as Prompts describes; --force (-f) skips it.
The last step fails with exit code 5 when the address has no suppression left, as in an account with one domain: the API answers 404 when nothing matches.

Wipe Suppressions

suppressions wipe deletes every suppression of the account, or of one domain with --domain. Protected suppressions (unsubscribes and spam complaints) are kept. The command prints a warning and asks for confirmation unless you give --force (-f). Back up first. One list call saves one page of up to 100 suppressions. Repeat it with --after set to the page’s pagination.next_cursor, in place of YOUR_CURSOR, until a page has no next_cursor. Add --domain to back up one domain. The example below wipes one domain. Replace example.com with a test domain in your account: the wipe deletes every suppression of that domain that is not protected.
A wipe cannot be undone. Afterwards, email can be sent to every wiped address again, which can hurt your sender reputation. The backup is for your records only: the CLI cannot import it, and suppressions create adds one address at a time.

Command Flags

These flags come from the CLI’s --help. All commands also accept the global flags.

suppressions check

suppressions create

suppressions delete

suppressions list

suppressions wipe

Next Steps