Delete a segment | Resend API (unofficial showcase)

1 parameter

idstringrequired

The ID of the segment to delete.

1 status code

200Returns the segment's ID, object type, and a boolean indicating whether it was deleted.

idstringoptional

The ID of the segment.

objectstringoptional

The object type.

deletedbooleanoptional

Indicates whether the segment was successfully deleted.

Error handling

The id path parameter must identify the segment to delete.

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

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

const result = await client.segments.delete({ id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
  "object": "segment",
  "deleted": true
}

Request

Response

Errors