Delete a suppression by ID or email | Resend API (unofficial showcase)

1 parameter

suppressionstringrequired

The suppression ID or email address to remove.

1 status code

200Returns the removed suppression's ID and a `deleted` value indicating whether it was deleted.

objectstringoptional

Type of the response object.

idstringoptional

Unique identifier for the removed suppression.

deletedbooleanoptional

Indicates whether the suppression was successfully deleted.

Error handling

The suppression path parameter must identify the suppression by its ID or email address.

import { Client } from "@octridev/resend";

const client = new Client({
  baseUrl: "https://api.resend.com",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.suppressions.delete({ suppression: "example" });

{
  "object": "suppression",
  "id": "e169aa45-1ecf-4183-9955-b1499d5701d3",
  "deleted": true
}

Request

Response

Errors