Listmonk icon

Listmonk

Interact with Listmonk API

Actions71

Overview

This node operation allows querying and modifying the blocklist status of subscribers in the Listmonk system. It supports actions such as adding, removing, or unsubscribing subscribers based on specified criteria like subscriber IDs, target list IDs, and status. This is useful for managing subscriber lists, ensuring compliance with user preferences, and maintaining clean mailing lists.

Use Case Examples

  1. Add subscribers to the blocklist by specifying their IDs and the target list IDs.
  2. Remove subscribers from the blocklist by providing their IDs and selecting the remove action.
  3. Unsubscribe subscribers from mailing lists based on their status and IDs.

Properties

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

Output

JSON

  • response - The JSON response from the Listmonk API after performing the blocklist query or modification.

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 that subscriber IDs and list IDs are valid and exist in the system to prevent errors related to non-existent entities.
  • If SSL certificate validation fails, consider enabling the option to ignore SSL issues, but be aware of the security implications.
  • Timeout errors may occur if the server is slow to respond; adjust the timeout setting accordingly.

Links

  • Listmonk API Documentation - Official documentation for the Listmonk API, useful for understanding available endpoints and request formats.

Discussion