Delete bounce records | listmonk unofficial

2 parameters

allbooleanoptional

A boolean flag for deleting multiple bounce records.

idstringoptional

A string containing the identifiers of the bounce records to delete.

1 status code

200Returns an object whose `data` field indicates whether the deletion operation completed.

databooleanoptional

Error handling

Use the all query parameter as a boolean flag for multiple-record deletion, or provide id as a string containing the bounce identifiers to delete.

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.bounces.delete({
  all: "example",
  id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
});

{
  "data": true
}

Request

Response

Errors