listmonk unofficial
PUT/subscribers/lists/{id}

Manage subscriber membership in a list

Manages subscriber membership in a specified list by adding, removing, or unsubscribing subscribers. Use the id path parameter to select the list and provide the subscriber selectors and action in the request body.

1 parameter · 5 body fields
idintegerrequired
The integer identifier of the list to update.

Selectors and settings for adding, removing, or unsubscribing subscribers in the specified list. 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

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