Listmonk Service icon

Listmonk Service

Call listmonk service endpoints.

Actions12

List → Update

AI-generated

Overview

The Listmonk Service node with the List resource and Update operation allows users to update the details of an existing list in the Listmonk system. This is useful for scenarios where you need to modify list attributes such as the list name, opt-in settings, tags, or type after the list has been created. For example, you might update a list's name to reflect a new campaign or change the opt-in method from single to double to comply with new regulations.

Use Case Examples

  1. Updating the name of a mailing list to 'Spring Campaign 2024'.
  2. Changing the opt-in setting of a list from single to double opt-in for better subscriber confirmation.
  3. Adding or modifying tags associated with a list to improve segmentation.

Properties

Name Meaning
List ID The unique identifier of the list to be updated.
List Name The new name to assign to the list.
List OptIn The subscriber opt-in setting for the list, either single or double opt-in.
List Tags Tags to be assigned to the list, allowing multiple tags to be added.
List Type The type of the list, which can be either private or public.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • id - The unique identifier of the updated list.
  • name - The updated name of the list.
  • opt_in - The updated opt-in setting of the list.
  • tags - The updated tags assigned to the list.
  • type - The updated type of the list (private or public).

Dependencies

  • An API key credential for authenticating with the Listmonk service.

Troubleshooting

  • Ensure the List ID provided is valid and exists in the Listmonk system to avoid errors related to non-existent lists.
  • Verify that the API credentials are correctly configured and have the necessary permissions to update lists.
  • Check network connectivity and proxy settings if requests fail or time out.
  • If SSL certificate validation errors occur, consider enabling the option to ignore SSL issues, but be aware of the security implications.

Discussion