Delete subscribers by ID | listmonk unofficial

1 parameter

idstringrequired

Subscriber ID or IDs to delete.

1 status code

200Returns a boolean in `data` indicating the result of the deletion.

databooleanoptional

Error handling

The id query parameter must identify one or more existing subscribers.

import { Client } from "listmonk-unofficial-sdk";

const client = new Client({
  baseUrl: "http://localhost:9000/api",
  auth: {
    username: process.env.API_USER,
    password: process.env.API_PASS,
  },
});

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

{
  "data": true
}

Request

Response

Errors