Listmonk icon

Listmonk

Interact with Listmonk API

Actions71

Overview

This node operation updates a subscriber in the Listmonk system by their unique ID. It is useful for scenarios where subscriber information such as email, name, status, or subscription lists need to be modified programmatically. For example, it can be used to update a subscriber's email address or change their subscription status based on user interactions or external data sources.

Use Case Examples

  1. Updating a subscriber's email and name after they submit a form.
  2. Changing the subscription status of a subscriber to 'unsubscribed' based on a user request.
  3. Adding or removing a subscriber from specific mailing lists by updating list UUIDs.

Properties

Name Meaning
Id The unique identifier of the subscriber to update. This is a required field to specify which subscriber record to modify.
Email The new email address of the subscriber. If provided, it updates the subscriber's email.
Name The new name of the subscriber. If provided, it updates the subscriber's name.
Status The subscription status of the subscriber, such as active or unsubscribed.
Lists A JSON array representing the lists to which the subscriber belongs. Used to update the subscriber's list memberships.
List Uuids A JSON array of list UUIDs to update the subscriber's list memberships.
Preconfirm Subscriptions A boolean flag indicating whether to preconfirm subscriptions without requiring further confirmation.
Attribs A JSON object containing additional attributes or metadata for the subscriber.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout duration.

Output

JSON

  • id - The unique identifier of the updated subscriber.
  • email - The updated email address of the subscriber.
  • name - The updated name of the subscriber.
  • status - The updated subscription status of the subscriber.
  • lists - The updated list memberships of the subscriber.
  • list_uuids - The updated list UUIDs associated with the subscriber.
  • attribs - Additional attributes or metadata of the subscriber.

Dependencies

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

Troubleshooting

  • Ensure the subscriber ID provided exists; otherwise, the update will fail with a 'not found' error.
  • Validate JSON format for 'lists', 'list_uuids', and 'attribs' fields to avoid parsing errors.
  • Check network connectivity and proxy settings if requests time out or fail to reach the API.
  • 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 formats.

Discussion