Listmonk icon

Listmonk

Interact with Listmonk API
Join our community

Actions71

Overview

This node operation creates a new campaign in the Listmonk system. It is useful for automating email or messenger marketing campaigns by programmatically defining campaign details such as name, subject, content, recipient lists, and scheduling options. For example, a user can create a campaign to send a promotional email to a specific list of subscribers at a scheduled time.

Use Case Examples

  1. Creating an email campaign with a subject, body content, and specifying the sender's email address.
  2. Scheduling a campaign to be sent later with a defined send time.
  3. Tagging campaigns and associating them with multiple recipient lists for targeted marketing.

Properties

Name Meaning
Name The name of the campaign.
Subject The subject line of the campaign email or message.
Body The main content or message body of the campaign.
Body Source The source format or origin of the campaign body content.
Lists The recipient lists to which the campaign will be sent, provided as a JSON array.
From Email The email address from which the campaign will be sent.
Content Type The content type of the campaign message (e.g., text/html).
Messenger The messenger platform used for the campaign, if applicable.
Type The type of campaign being created.
Tags Tags associated with the campaign, provided as a JSON array.
Send Later Boolean flag indicating whether the campaign should be sent later (scheduled) or immediately.
Send At The scheduled time to send the campaign, provided as a JSON object.
Request Options Additional request options such as batching, SSL certificate handling, proxy settings, and timeout configuration.

Output

JSON

  • id - The unique identifier of the created campaign.
  • name - The name of the created campaign.
  • subject - The subject of the created campaign.
  • body - The body content of the created campaign.
  • body_source - The source format or origin of the campaign body content.
  • lists - The recipient lists associated with the campaign.
  • from_email - The sender email address of the campaign.
  • content_type - The content type of the campaign message.
  • messenger - The messenger platform used for the campaign.
  • type - The type of the campaign.
  • tags - Tags associated with the campaign.
  • send_later - Indicates if the campaign is scheduled to be sent later.
  • send_at - The scheduled send time of the campaign.

Dependencies

  • An API key credential for authenticating with the Listmonk API

Troubleshooting

  • Ensure the API base URL and credentials are correctly configured to avoid authentication errors.
  • Validate JSON input for 'lists', 'tags', and 'send_at' properties to prevent parsing errors.
  • Check network connectivity and proxy settings if requests fail or time out.
  • If SSL certificate validation fails, consider enabling the option to ignore SSL issues, but be aware of security risks.

Links

  • Listmonk API Documentation - Official API documentation for Listmonk, useful for understanding campaign creation and other operations.

Discussion