Listmonk icon

Listmonk

Interact with a listmonk instance

Overview

The node "Listmonk" allows interaction with a listmonk instance, which is an open-source self-hosted newsletter and mailing list manager. The specific operation "Delete List" under the "List" resource enables users to delete a mailing list by specifying its unique ID. This operation is useful for managing mailing lists by removing obsolete or unwanted lists from the system.

Common scenarios include:

  • Cleaning up unused or test mailing lists.
  • Automating list management workflows where lists are programmatically deleted after certain conditions.
  • Maintaining an organized set of mailing lists by removing duplicates or outdated entries.

Example: A marketing automation workflow could use this node to delete a mailing list once a campaign targeting that list has concluded.

Properties

Name Meaning
ID The unique identifier of the mailing list to be deleted. This is a required string property.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will confirm whether the deletion was successful or provide error details if it failed. There is no indication that binary data is output by this node.

Dependencies

  • Requires connection to a listmonk instance via its API.
  • Needs credentials including domain URL, username, and password for authentication.
  • The base URL for API requests is constructed from the provided domain credential.
  • The node expects the API to accept and return JSON-formatted data.

Troubleshooting

  • Invalid ID: If the provided list ID does not exist, the API may return an error indicating the list was not found. Verify the ID before attempting deletion.
  • Authentication errors: Incorrect credentials (domain, username, or password) will cause authentication failures. Ensure credentials are correct and have sufficient permissions.
  • Network issues: Connectivity problems to the listmonk server will prevent the node from functioning. Check network access and server availability.
  • API changes: If the listmonk API version changes, some operations might fail. Confirm compatibility between the node and the listmonk instance.

Links and References

Discussion