listmonk unofficial
PUT/subscribers/lists

Manage subscriber list membership

Manages subscriber membership across lists by adding, removing, or unsubscribing subscribers. Supply action and the subscriber or list selectors that define which records to modify; action must be add, remove, or unsubscribe.

5 body fields

Selectors and settings for adding, removing, or unsubscribing subscribers from lists. 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 list membership 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.