Listmonk icon

Listmonk

Interact with Listmonk API
Join our community

Actions71

Overview

This node operation manages subscriber lists by query in the Listmonk API. It allows users to add, remove, or unsubscribe subscribers from specified lists based on a query and subscriber IDs. This is useful for bulk managing subscriber statuses and list memberships efficiently, such as adding multiple subscribers to a marketing list or removing unsubscribed users from all lists.

Use Case Examples

  1. Add subscribers matching a query to a specific list.
  2. Remove subscribers by their IDs from certain lists.
  3. Unsubscribe users from lists based on their status and query.

Properties

Name Meaning
Query A string query to filter subscribers to be modified.
Ids The JSON array of subscriber IDs to be modified.
Action The action to perform on the subscribers: add, remove, or unsubscribe.
Target List Ids The IDs of the subscriber lists to be modified.
Status The status filter for subscribers: confirmed, unconfirmed, or unsubscribed.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout.

Output

JSON

  • success - Indicates if the operation was successful.
  • modifiedCount - Number of subscribers modified by the operation.
  • action - The action performed on the subscribers (add, remove, unsubscribe).

Dependencies

  • Requires an API key credential for authenticating with the Listmonk API.

Troubleshooting

  • Ensure the API base URL and credentials are correctly configured to avoid authentication errors.
  • Check the query syntax and subscriber IDs format to prevent request failures.
  • If batching is enabled, adjust batch size and interval to avoid rate limiting or timeouts.
  • Verify SSL certificate settings if encountering SSL validation errors, especially when using self-signed certificates.

Links

Discussion