Listmonk icon

Listmonk

Interact with Listmonk API

Actions71

Overview

This node operation manages the blocklist status of subscribers in bulk by their IDs within specified subscriber lists. It allows adding, removing, or unsubscribing subscribers from blocklists across one or more target lists. This is useful for marketing automation or email campaign management where you need to control subscriber statuses efficiently in bulk, such as blocking certain users from receiving emails or cleaning up subscriber lists.

Use Case Examples

  1. Add multiple subscribers to the blocklist of specific lists to prevent them from receiving future emails.
  2. Remove subscribers from the blocklist to allow them to receive emails again.
  3. Unsubscribe a batch of subscribers from all communications by updating their status accordingly.

Properties

Name Meaning
Query A string query parameter that can be used to filter or specify conditions for managing subscribers in the blocklist.
Ids A JSON array containing the IDs of the subscribers to be modified in the blocklist.
Action The action to perform on the subscribers: add them to the blocklist, remove them from it, or unsubscribe them.
Target List Ids An array of IDs representing the subscriber lists to be modified.
Status The status to set for the subscribers, which can be confirmed, unconfirmed, or unsubscribed.
Request Options Additional request options such as batching parameters, SSL certificate validation, proxy settings, and request timeout.

Output

JSON

  • success - Indicates whether the blocklist management operation was successful.
  • modifiedCount - The number of subscribers that were modified by the operation.
  • action - The action performed on the subscribers (add, remove, unsubscribe).
  • targetListIds - The IDs of the subscriber lists that were targeted for modification.

Dependencies

  • An API key credential for authenticating with the Listmonk API

Troubleshooting

  • Ensure the subscriber IDs and target list IDs are valid and exist in the system to avoid errors.
  • Check that the API credentials are correctly configured and have the necessary permissions to modify subscriber blocklists.
  • If batching is enabled, verify that batch size and interval settings are appropriate to avoid rate limiting or timeouts.
  • SSL certificate validation errors can be bypassed by enabling the 'Ignore SSL Issues' option, but this should be used cautiously due to security risks.

Discussion