Listmonk icon

Listmonk

Interact with Listmonk API

Actions71

Overview

This node operation updates the archive status and related details of a campaign by its ID in the Listmonk system. It is useful for managing campaign archives, such as archiving or unarchiving campaigns, updating the archive template, and modifying archive metadata. Practical examples include automating campaign lifecycle management or integrating campaign archival status updates into a workflow.

Use Case Examples

  1. Archiving a campaign after it has been completed.
  2. Updating the archive template ID for a specific campaign.
  3. Modifying metadata associated with a campaign's archive status.

Properties

Name Meaning
Id The unique identifier of the campaign to update the archive status for.
Archive Boolean flag to set whether the campaign should be archived (true) or unarchived (false).
Archive Template Id Numeric ID of the archive template to associate with the campaign.
Archive Meta JSON object containing metadata related to the campaign archive.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • id - The ID of the updated campaign.
  • archive - The updated archive status of the campaign.
  • archive_template_id - The archive template ID associated with the campaign.
  • archive_meta - Metadata related to the campaign archive.

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 a not found error.
  • Verify that the API key credential is valid and has sufficient permissions to update campaigns.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option or configuring a proper proxy.
  • Batching settings should be adjusted carefully to avoid rate limiting or timeouts.

Links

Discussion