Listmonk icon

Listmonk

Interact with Listmonk API

Actions71

Overview

This node operation updates the status of a specific campaign by its ID in the Listmonk system. It is useful for managing campaign workflows, such as scheduling, running, pausing, or cancelling campaigns programmatically within an automation workflow. For example, a user can automate the process of pausing a campaign based on certain triggers or conditions in their workflow.

Use Case Examples

  1. Updating a campaign status to 'running' when a marketing event starts.
  2. Pausing a campaign automatically if certain criteria are met during a workflow execution.

Properties

Name Meaning
Id The unique identifier of the campaign whose status you want to update.
Status The new status to set for the campaign. Options include Scheduled, Running, Paused, and Cancelled.
Request Options Additional HTTP request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • id - The ID of the campaign that was updated.
  • status - The updated status of the campaign.
  • message - A message indicating the result of the update operation.

Dependencies

  • Requires an API key credential for authenticating with the Listmonk API.

Troubleshooting

  • Ensure the campaign ID provided exists; otherwise, the update will fail with an error indicating the campaign was not found.
  • Verify that the status value is one of the allowed options (scheduled, running, paused, cancelled) to avoid validation errors.
  • Check network connectivity and proxy settings if requests time out or fail to reach the API.
  • If SSL certificate validation errors occur, consider enabling the option to ignore SSL issues, but be aware of the security implications.

Links

  • Listmonk API Documentation - Official API documentation for Listmonk, useful for understanding available endpoints and request/response formats.

Discussion