Manage the subscriber blocklist | listmonk unofficial

5 body fields

Selectors and settings for managing subscribers on the blocklist. The request body is optional and no fields are required by the schema.

querystringoptional

SQL expression to select subscribers.

idsarray<integer>optional

The ids of the subscribers to be modified.

actionstringoptional

Whether to add, remove, or unsubscribe the users.

Allowed:addremoveunsubscribe

target_list_idsintegeroptional

The ids of the lists to be modified.

statusstringoptional

confirmed, unconfirmed, or unsubscribed status.

Allowed:confirmedunconfirmedunsubscribed

1 status code

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

databooleanoptional

Error handling

action must be add, remove, or unsubscribe, and status must be confirmed, unconfirmed, or unsubscribed. The request body is optional and has no required fields; ids must contain integers when provided.

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.blocklist.update({
  query: "keyword",
  ids: [],
  action: "example",
  targetListIds: 20,
  status: "example",
});

{
  "data": true
}

Request

Response

Errors