Listmonk Service icon

Listmonk Service

Call listmonk service endpoints.

Actions9

Overview

The node implements integration with the Listmonk service, specifically focusing on managing mailing lists. The "List - Update" operation allows users to modify existing mailing lists by changing their name, opt-in settings, tags, and type. This is useful for maintaining up-to-date subscriber lists in email marketing campaigns or communication workflows.

Practical examples include:

  • Renaming a list to reflect a new campaign title.
  • Changing the opt-in method from single to double opt-in to comply with stricter subscription policies.
  • Adding or updating tags to categorize lists for targeted messaging.
  • Switching a list's visibility between private and public.

Properties

Name Meaning
List ID The unique identifier of the list to update.
List Name The new name to assign to the list.
List OptIn Subscriber opt-in setting; options are: Single (one-step subscription) or Double (two-step confirmation).
List Tags Tags to assign to the list; multiple tags can be added to help categorize or segment the list.
List Type The type of the list; options are Private (restricted access) or Public (open access).

Output

The node outputs JSON data representing the updated list object as returned by the Listmonk API. This typically includes fields such as the list's ID, name, opt-in setting, tags, type, and possibly metadata like creation or modification timestamps.

If the node supports binary data output, it would relate to any file attachments or exports associated with the list, but this is not indicated in the provided code or properties.

Dependencies

  • Requires an API key credential for authenticating with the Listmonk service.
  • Needs the base URL of the Listmonk instance configured in credentials.
  • The node sends requests to the Listmonk API endpoint /api with JSON payloads.

Troubleshooting

  • Invalid List ID: If the specified List ID does not exist, the API will likely return an error indicating the list was not found. Verify the List ID before running the node.
  • Authentication Errors: Missing or incorrect API credentials will cause authentication failures. Ensure the API key and host URL are correctly set in the node credentials.
  • Validation Errors: Providing invalid values for properties like listOptIn or listType may result in errors. Use only the supported options.
  • Network Issues: Connectivity problems to the Listmonk server will prevent successful updates. Check network access and server availability.

Links and References

Discussion