Listmonk Service icon

Listmonk Service

Call listmonk service endpoints.

Actions9

Overview

The node integrates with the Listmonk service to manage subscribers within mailing lists. Specifically, for the "Subscriber" resource and the "Manage Subscriber List" operation, it allows users to add, remove, or unsubscribe subscribers from one or more mailing lists. This is useful in scenarios such as bulk updating subscriber memberships, cleaning up mailing lists, or managing subscription statuses programmatically.

Practical examples include:

  • Adding a batch of new subscribers to multiple mailing lists with a confirmed subscription status.
  • Removing certain subscribers from specific lists when they opt out.
  • Unsubscribing users automatically based on external triggers or user actions.

Properties

Name Meaning
Subscriber IDs JSON array of subscriber IDs to be managed (added, removed, or unsubscribed)
Action The action to perform on the subscribers: Add, Remove, or Unsubscribe
List IDs JSON array of list IDs where the subscribers will be managed
Subscription Status When adding subscribers, select their subscription status: Confirmed, Unconfirmed, or Unsubscribed

Output

The node outputs JSON data representing the result of the subscriber list management operation. This typically includes confirmation of the performed action, any errors encountered per subscriber or list, and possibly updated subscriber information. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating with the Listmonk service.
  • The node expects the base URL of the Listmonk API to be configured in the credentials.
  • The node sends requests with JSON payloads and expects JSON responses.

Troubleshooting

  • Invalid Subscriber or List IDs: If the provided subscriber or list IDs are incorrect or do not exist, the API may return errors. Verify IDs before running the node.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
  • Action Mismatch: The "Subscription Status" property only applies when adding subscribers. Setting it for other actions will have no effect.
  • Empty Arrays: Providing empty arrays for subscriber or list IDs will likely result in no changes; ensure these fields are populated correctly.
  • API Endpoint Issues: Confirm the base URL is correct and accessible from your environment.

Links and References

Discussion