Listmonk Tool icon

Listmonk Tool

AI-optimized tool for managing email marketing with Listmonk. Call this tool to create subscribers, send emails, manage campaigns, and handle email marketing operations through natural language.

Actions8

Create Subscriber

AI-generated

Overview

The node provides an interface to manage email marketing subscribers using the Listmonk API. Specifically, the Create Subscriber operation allows users to add a new subscriber to one or more mailing lists managed by Listmonk. This is useful for automating subscriber management workflows such as adding new contacts collected from web forms, CRM systems, or other sources directly into your email marketing platform.

Practical examples include:

  • Automatically subscribing new customers who sign up on your website.
  • Importing subscribers from external databases or services.
  • Managing subscription preferences programmatically without manual intervention.

Properties

Name Meaning
Subscriber Email The email address of the subscriber. Must be a valid email format (e.g., user@example.com).
Subscriber Name The full name of the subscriber (optional).
Subscriber Status The status of the subscriber in the system. Options: Enabled, Disabled, Blocklisted.
Subscriber Lists (JSON) JSON array of list IDs to which the subscriber should be added (e.g., [1, 2, 3]).
Subscriber Attributes (JSON) Custom attributes for the subscriber as a JSON object (e.g., {"age":30,"city":"NY"}).
Preconfirm Subscriptions Boolean flag indicating whether to preconfirm subscriptions, skipping confirmation emails.

Output

The node outputs the response from the Listmonk API after creating the subscriber. The output is a JSON object containing details about the newly created subscriber, including their assigned ID and any metadata returned by the API.

No binary data is produced by this operation.

Dependencies

  • Requires connection to a Listmonk instance with API access.
  • Needs credentials including domain URL, username, and password for authentication.
  • The node uses HTTP Basic Authentication to communicate with the Listmonk API.
  • Ensure the Listmonk API endpoint is reachable and properly configured.

Troubleshooting

  • Invalid Email Format: If the subscriber email does not match the required regex pattern, the node will reject the input. Make sure to provide a valid email address.
  • Authentication Errors: If credentials are incorrect or missing, the API call will fail. Verify that the API domain, username, and password are correctly set in the node credentials.
  • List IDs Not Found: Providing invalid or non-existent list IDs in the subscriber lists array may cause errors or the subscriber not being added to any list. Confirm list IDs exist in your Listmonk instance.
  • API Connectivity Issues: Network problems or incorrect base URL configuration can prevent successful API calls. Check network connectivity and ensure the base URL is correct without trailing slashes.
  • Preconfirm Flag Misuse: Setting preconfirmSubscriptions to false will require subscribers to confirm via email, which might delay subscription activation.

Links and References

Discussion