listmonk unofficial
PUT/subscribers/{id}/blocklist

Manage a subscriber's blocklist

Manages the blocklist for the subscriber identified by the path parameter. Use the id path parameter to select the subscriber and provide the action and any additional selectors in the request body.

1 parameter · 5 body fields
idintegerrequired
The integer identifier of the subscriber whose blocklist to manage.

Selectors and settings for managing subscriber blocklist entries. 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

The id path parameter must be an integer that identifies an existing subscriber. action must be add, remove, or unsubscribe, and status must be confirmed, unconfirmed, or unsubscribed.