Listmonk icon

Listmonk

Interact with a listmonk instance for email marketing and newsletter management. Supports creating subscribers, managing campaigns, sending emails, and more.

Actions32

Campaign → Get Preview by ID

AI-generated

Overview

The node integrates with a Listmonk instance, an email marketing and newsletter management platform. Specifically, the "Get Preview by ID" operation under the "Campaign" resource retrieves a preview of a campaign using its unique numeric ID. This is useful for users who want to fetch and review the content or details of a specific campaign before sending or analyzing it.

Practical examples:

  • Previewing the content of a scheduled email campaign to verify formatting and links.
  • Fetching campaign previews programmatically to display in custom dashboards.
  • Automating quality checks on campaigns before execution.

Properties

Name Meaning
ID The unique identifier (number) of the campaign whose preview you want to retrieve. Must be a valid number corresponding to an existing campaign.

Output

The output JSON contains the detailed preview data of the specified campaign. This typically includes the campaign's content, subject, sender information, and other metadata relevant to how the campaign will appear to recipients.

If the node supports binary data output (not explicitly shown here), it would likely represent attachments or media related to the campaign preview, but this is not indicated in the provided code snippet.

Dependencies

  • Requires connection to a Listmonk instance via 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 uses HTTP Basic Authentication with the supplied username and password.

Troubleshooting

  • Invalid ID error: If the provided campaign ID does not exist or is invalid, the node may return an error indicating the campaign was not found. Verify the ID is correct and corresponds to an existing campaign.
  • Authentication errors: Incorrect or missing credentials will cause authentication failures. Ensure the API credentials are correctly configured.
  • Network issues: Connectivity problems to the Listmonk server can cause request failures. Check network access and the correctness of the domain URL.
  • API changes: If the Listmonk API changes, some operations might fail unexpectedly. Confirm compatibility with the current Listmonk version.

Links and References

Discussion