Actions9
- List Actions
- Subscriber Actions
- Transactional Message Actions
Overview
The "Update Subscriber" operation in the Subscriber resource allows users to modify existing subscriber details within a mailing list management system. This node is useful for keeping subscriber information current, such as updating their name, email, subscription status, list memberships, and additional custom attributes. It supports scenarios like correcting subscriber data, changing subscription preferences, or managing subscriber segmentation by lists.
Practical examples include:
- Updating a subscriber’s email address after they notify of a change.
- Changing a subscriber’s status to blocklisted if they request to be unsubscribed or marked inactive.
- Adding or removing subscribers from specific mailing lists dynamically based on user behavior or preferences.
- Storing extra metadata about subscribers in JSON format for personalized marketing.
Properties
Name | Meaning |
---|---|
Subscriber ID | Numeric identifier of the subscriber to update. |
Subscriber Name | The full name of the subscriber. Required for update operations. |
Subscriber Email | The email address of the subscriber. Required for update operations. |
Subscriber Status | Current status of the subscriber. Options: "Enabled" (active subscriber), "Blocklisted" (blocked). |
Lists | JSON array of list IDs to which the subscriber should be added. |
Additional Attributes | Optional JSON object containing extra subscriber data fields for customization. |
Pre-Confirm Subscription | Boolean flag indicating whether the subscription should be pre-confirmed, bypassing double opt-in emails. |
Output
The node outputs JSON data representing the updated subscriber record. This typically includes all subscriber fields such as ID, name, email, status, associated lists, and any additional attributes. The output structure reflects the subscriber's current state after the update operation.
If binary data were involved (not indicated here), it would represent attachments or files related to the subscriber, but this node focuses solely on JSON subscriber data.
Dependencies
- Requires an API key credential for authenticating with the Listmonk service.
- Needs the base URL of the Listmonk API configured in the node credentials.
- The node depends on the Listmonk API endpoints to perform subscriber updates.
Troubleshooting
Common Issues:
- Providing an invalid or missing Subscriber ID will cause the update to fail because the target subscriber cannot be identified.
- Incorrect JSON formatting in "Lists" or "Additional Attributes" fields may result in parsing errors.
- Using an email that conflicts with another subscriber might cause uniqueness constraint errors.
- Insufficient permissions or incorrect API credentials will lead to authentication failures.
Error Messages:
- "Subscriber not found": Verify the Subscriber ID is correct and exists.
- "Invalid JSON format": Check the syntax of JSON inputs for lists or attributes.
- "Unauthorized" or "Authentication failed": Confirm API credentials are valid and have necessary access rights.
- "Email already exists": Ensure the new email does not duplicate another subscriber’s email.
Resolving these usually involves validating input data, checking API credentials, and ensuring the subscriber exists before attempting updates.
Links and References
- Listmonk Official Documentation
- Listmonk API Reference
- General JSON formatting guide: https://www.json.org/json-en.html