Listmonk icon

Listmonk

Interact with a listmonk instance

Actions32

Overview

The node integrates with a Listmonk instance, focusing here on the Template resource and specifically the Modify operation. This operation allows users to update an existing email template in their Listmonk system. Templates typically define the content and structure of emails sent out as campaigns or transactional messages.

Common scenarios for this node include:

  • Updating the subject line or body content of an existing email template.
  • Changing the type of the template between campaign and transactional.
  • Renaming a template to better reflect its purpose.

Practical example: A marketing team wants to update the promotional email template's subject and body before launching a new campaign. Using this node, they can programmatically modify the template without manually editing it in the Listmonk UI.

Properties

Name Meaning
Name The name of the template. Used to identify the template within Listmonk.
Subject The subject line of the email template.
Type The type of the template. Options are: Campaign (for marketing campaigns) or Transactional (for automated transactional emails).
Body The main content/body of the email template, supporting code editing (e.g., HTML).
ID The unique identifier of the template to be modified. Required to specify which template to update.

Output

The node outputs JSON data representing the updated template object after modification. This typically includes fields such as the template's ID, name, subject, type, body content, and possibly metadata like timestamps or status.

If the node supports binary data output (not indicated here), it would generally relate to attachments or media associated with templates, but no such indication is present in the provided code snippet.

Dependencies

  • Requires connection to a Listmonk instance via its API.
  • Needs credentials including domain URL, username, and password for authentication.
  • The node expects the Listmonk API to be accessible and properly configured to accept requests for modifying templates.

Troubleshooting

  • Invalid ID error: If the provided template ID does not exist, the API will likely return an error. Ensure the ID is correct and corresponds to an existing template.
  • Authentication failures: Incorrect credentials or domain URL will prevent successful API calls. Verify that the API credentials and domain are correctly set in the node configuration.
  • Validation errors: Missing required fields like Name or ID will cause the node to fail. Make sure all mandatory properties are provided.
  • API connectivity issues: Network problems or incorrect base URL formatting may cause request failures. Confirm network access and that the domain URL does not have trailing slashes.

Links and References

Discussion