Listmonk icon

Listmonk

Interact with a listmonk instance

Overview

The node integrates with a list management system to manage subscribers within mailing lists. Specifically, the "Manage Subscriber List" operation allows users to add, remove, or unsubscribe subscribers from one or multiple lists. This is useful for automating subscriber management tasks such as bulk updating subscription statuses, cleaning up mailing lists, or handling user preferences dynamically.

Practical examples include:

  • Adding new subscribers collected from a web form to specific mailing lists.
  • Removing unsubscribed users from all lists to comply with opt-out requests.
  • Changing subscription status of users based on engagement or campaign results.

Properties

Name Meaning
Subscriber IDs JSON array of subscriber identifiers 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 identifiers where the subscribers will be added or removed.
Subscription Status The status to assign to the subscriber when adding or managing them: Confirmed, Unconfirmed, or Unsubscribed.

Output

The node outputs JSON data representing the result of the subscriber management operation. This typically includes confirmation of the performed actions, such as which subscribers were successfully added, removed, or unsubscribed, and any relevant metadata returned by the list management API.

If binary data output is supported, it would generally represent attachments or media related to subscribers, but this operation focuses on JSON data only.

Dependencies

  • Requires connection to a list management service via an API.
  • Needs credentials including domain URL, username, and password for authentication.
  • The base URL for API requests is constructed from the provided domain credential.
  • The node expects the API to accept and return JSON-formatted data.

Troubleshooting

  • Invalid Subscriber or List IDs: Ensure that the subscriber and list IDs are valid JSON arrays and correspond to existing entities in the list management system.
  • Authentication Errors: Verify that the API credentials (domain, username, password) are correct and have sufficient permissions.
  • Action Not Supported: Confirm that the selected action is one of the supported options (Add, Remove, Unsubscribe).
  • Subscription Status Mismatch: When adding subscribers, ensure the subscription status is correctly set; some APIs may reject invalid or unsupported statuses.
  • API Connectivity Issues: Check network connectivity and that the API endpoint is reachable.

Common error messages might include authentication failures, invalid input format errors, or permission denials. Resolving these usually involves verifying credentials, input data formatting, and API access rights.

Links and References

  • Official list management API documentation (refer to your specific list management service).
  • n8n documentation on creating and using custom nodes.
  • JSON formatting guides for preparing subscriber and list ID arrays.

Discussion