Warmr Lists icon

Warmr Lists

Manage Warmr lists and list membership via the v1 API

Update List

AI-generated

Overview

This node operation updates an existing list in the Warmr system using the Warmr API. It allows users to modify the list's name, description, and icon by specifying the list's UUID and the new values for these fields. This operation is useful for maintaining and managing list details dynamically, such as renaming a list, updating its description, or changing its icon.

Use Case Examples

  1. Updating a mailing list's name and description to reflect a new campaign.
  2. Changing the icon of a contact list to better categorize it visually.

Properties

Name Meaning
List UUID The unique identifier of the list to update. This is required to specify which list will be modified.
Name The new name for the list. This is optional but if provided, it updates the list's name.
Description The new description for the list. This is optional and updates the list's description if provided.
Icon The new icon for the list. This is optional and updates the list's icon if provided.

Output

JSON

  • json - The updated list object returned from the Warmr API after the update operation.

Dependencies

  • Requires an API key credential for the Warmr API to authenticate requests.

Troubleshooting

  • Common issues include providing an invalid or missing List UUID, which will cause the update to fail.
  • If the API key credential is invalid or missing, authentication errors will occur.
  • Errors returned from the API will be captured and returned in the output as an error message in the JSON response.

Discussion