Listmonk icon

Listmonk

Interact with a listmonk instance

Overview

The node integrates with a Listmonk instance to manage subscribers. Specifically, the "Create a New Subscriber" operation allows users to add new subscribers to their mailing lists within Listmonk. This is useful for automating subscriber management workflows such as adding contacts collected from forms, CRM systems, or other sources directly into Listmonk for email marketing campaigns.

Practical examples include:

  • Automatically adding new customers from an e-commerce platform to a newsletter list.
  • Importing event attendees into a mailing list for follow-up communications.
  • Syncing user sign-ups from a web app to maintain an updated subscriber database.

Properties

Name Meaning
Name The full name of the subscriber. Required field.
Email The subscriber's email address.
Status The status of the subscriber. Options: Enabled, Disabled, Blocklisted.
Lists JSON array specifying the lists to which the subscriber should be added.
Attributes JSON object containing additional subscriber attributes (custom fields).
Preconfirm Subscriptions Boolean flag indicating if subscriptions should be preconfirmed (true means no double opt-in emails sent).

Output

The node outputs JSON data representing the result of the subscriber creation request. This typically includes details about the newly created subscriber such as their ID, status, and any metadata returned by the Listmonk API.

If binary data were involved (not indicated here), it would represent attachments or media related to the subscriber, but this operation focuses on JSON subscriber data only.

Dependencies

  • Requires access to a Listmonk instance with API enabled.
  • Needs credentials including domain URL, username, and password for basic authentication.
  • The node expects the Listmonk API to be reachable at the configured base URL.

Troubleshooting

  • Authentication errors: Ensure that the provided credentials (username, password) and domain URL are correct and have sufficient permissions.
  • Invalid JSON in Lists or Attributes: The Lists and Attributes properties expect valid JSON input; malformed JSON will cause errors.
  • Email validation failures: The subscriber email must be valid; invalid formats may be rejected by the API.
  • Status option issues: Only the specified statuses ("enabled", "disabled", "blocklisted") are accepted; using unsupported values will cause errors.
  • Network connectivity: Verify network access to the Listmonk API endpoint.

Links and References

Discussion