Remove a suppression

DELETE/v1/admin/suppressions/{address}Admin key

Removes the address from Flaresend's list, for every project. It does not touch Cloudflare's own suppression list. If Cloudflare also suppressed the address, sends will still fail there (the email ends up rejected); remove it in the Cloudflare dashboard too.

Removing an address that isn't on the list is not an error: the response has deleted: false.

Path parameters

addressstringpathrequired

The address, URL-encoded (@ becomes %40). Matched case-insensitively.

Response

addressstring

The lowercased address.

deletedboolean

true if the address was on the list, false if it wasn't.

notestring

A reminder that Cloudflare keeps a separate suppression list.

Request

const address = encodeURIComponent('grace@example.com');
const res = await fetch(`https://mailer.example.com/v1/admin/suppressions/${address}`, {
  method: 'DELETE',
  headers: { Authorization: `Bearer ${process.env.FLARESEND_ADMIN_KEY}` },
});
const { deleted } = await res.json();

Response

{
  "address": "grace@example.com",
  "deleted": true,
  "note": "This is Flaresend's local mirror. Cloudflare keeps its own suppression list; edit that one in the Cloudflare dashboard (Email Service)."
}

Path parametersCopy Anchor Link

ResponseCopy Anchor Link

Path parameters

Response