Delete a mailing list | listmonk unofficial

1 parameter

list_idintegerrequired

The integer ID of the mailing list to delete.

1 status code

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

databooleanoptional

Error handling

The list_id path parameter must be an integer identifying the mailing list to delete. This endpoint targets a single list by its URI identifier.

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.lists.delete({ listId: "c0a80123-4567-89ab-cdef-0123456789ab" });

{
  "data": true
}

Request

Response

Errors