Delete orphaned or blocklisted subscribers

1 parameter

typestringrequired

The type of subscribers to garbage collect.

1 status code

200Returns a `data` object containing the number of subscribers deleted.

dataobjectoptional

Error handling

The type path parameter specifies the category of subscribers to collect.

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({ type: "example" });

{
  "data": {
    "count": 42
  }
}

Request

Response

Errors