Listmonk icon

Listmonk

Interact with Listmonk API

Actions71

Overview

This node operation updates an existing list in the Listmonk system by its unique identifier (List Id). It allows users to modify various attributes of the list such as its name, type, description, tags, subscriber count, and timestamps for creation and updates. This operation is useful for managing and maintaining mailing lists or subscriber groups within Listmonk, ensuring that list details remain current and accurate.

Use Case Examples

  1. Updating the name and description of a mailing list to reflect a new campaign.
  2. Changing the type or tags of a list to better categorize subscribers.
  3. Adjusting subscriber count or opt-in status based on recent data imports.

Properties

Name Meaning
List Id The unique identifier of the list to update, required to specify which list to modify.
Id The internal id value of the list, sent in the request body to identify the list.
Created At Timestamp indicating when the list was created, can be updated.
Updated At Timestamp indicating the last update time of the list.
Uuid The universally unique identifier for the list.
Name The name of the list.
Type The type/category of the list.
Optin Opt-in status or related information for the list.
Tags JSON array of tags associated with the list.
Subscriber Count Number of subscribers in the list.
Description Description text for the list.
Request Options Settings for request behavior such as batching, SSL validation, proxy, and timeout.

Output

JSON

  • id - The unique identifier of the updated list.
  • created_at - Timestamp when the list was created.
  • updated_at - Timestamp when the list was last updated.
  • uuid - The universally unique identifier of the list.
  • name - The name of the list.
  • type - The type or category of the list.
  • optin - Opt-in status or related information.
  • tags - Array of tags associated with the list.
  • subscriber_count - Number of subscribers in the list.
  • description - Description of the list.

Dependencies

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

Troubleshooting

  • Ensure the List Id provided is correct and exists in the Listmonk system to avoid 'list not found' errors.
  • Verify that the API key credential is valid and has sufficient permissions to update lists.
  • Check network connectivity and proxy settings if requests fail or time out.
  • If SSL certificate validation fails, consider enabling the 'Ignore SSL Issues' option cautiously.

Links

  • Listmonk API Documentation - Official documentation for the Listmonk API, useful for understanding available endpoints and data structures.

Discussion