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 Create" operation allows users to create a new mailing list within their Listmonk instance. This is useful for scenarios where you want to programmatically organize subscribers into distinct groups for targeted email campaigns or communications.

Practical examples include:

  • Automatically creating a new subscriber list when onboarding a new client or project.
  • Setting up segmented mailing lists based on user preferences collected from a form.
  • Creating public or private lists with specific opt-in settings and tags to manage subscription workflows efficiently.

Properties

Name Meaning
List Name Name of the new list to be created
List OptIn Subscriber opt-in setting for the list; options are: Single (one-step opt-in) or Double (two-step opt-in)
List Tags Tags to be assigned to the list; multiple tags can be added to categorize or label the list
List Type Type of the list to be created; options are Private (restricted access) or Public (open access)

Output

The node outputs JSON data representing the newly created list object as returned by the Listmonk API. This typically includes details such as the list ID, name, type, opt-in setting, tags, and other metadata related to the list configuration.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to a Listmonk service instance.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • The base URL for the Listmonk API is derived from the provided host credential, ensuring requests target the correct server endpoint.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing an empty or duplicate list name may result in errors from the Listmonk API.
    • Incorrectly formatted tags or unsupported list types could lead to request rejections.
  • Error messages and resolutions:

    • 401 Unauthorized: Check that the API key credential is correctly set and has sufficient permissions.
    • 400 Bad Request: Verify that all required properties (like List Name) are provided and valid.
    • Conflict or Duplicate Resource Error: Ensure the list name is unique within your Listmonk instance.

Links and References

Discussion