Delete an audience

DELETE/v1/audiences/{id}API key

Deletes the audience and its membership list. The contacts themselves are not deleted; they stay in the project and in any other audiences.

An audience can't be deleted while a broadcast to it is scheduled or sending. Cancel the broadcast first.

Path parameters

idstringpathrequired

The audience ID.

Response

idstring

The ID of the deleted audience.

deletedtrue

Always true.

Errors

Status	Code	When
404	`audience_not_found`	No audience with that ID in this project.
409	`audience_in_use`	A broadcast to this audience is scheduled or sending.

Request

import { Flaresend } from '@flaresend/client';

const flaresend = new Flaresend({
  apiKey: process.env.FLARESEND_API_KEY!,
  baseUrl: 'https://mailer.example.com',
});

await flaresend.audiences.remove('aud_01K6C2A7F3H5J8K1M4N6P9Q2RS');

Response

{
  "id": "aud_01K6C2A7F3H5J8K1M4N6P9Q2RS",
  "deleted": true
}

Path parametersCopy Anchor Link

ResponseCopy Anchor Link

ErrorsCopy Anchor Link

Path parameters

Response

Errors