Actions32
- Campaign Actions
- List Actions
- Media Actions
- Setting Actions
- Subscriber Actions
- Template Actions
- Transaction Actions
Overview
The node integrates with a Listmonk instance to manage subscribers within mailing lists. Specifically, the "Modify a Subscriber" operation allows updating details of an existing subscriber such as their email, status, list memberships, and custom attributes. This is useful in scenarios where subscriber information needs to be kept current, for example, updating contact details, changing subscription preferences, or managing subscriber statuses (enabled, disabled, blocklisted).
Practical examples include:
- Updating a subscriber's email address after they request a change.
- Changing a subscriber's status to "disabled" if they opt out.
- Adding or removing a subscriber from specific mailing lists.
- Modifying custom attributes like name or other metadata associated with the subscriber.
Properties
| Name | Meaning |
|---|---|
| Name | The subscriber's name. Required when creating or modifying templates or subscribers. |
| Subscriber ID | The unique numeric identifier of the subscriber to modify. |
| The subscriber's email address. | |
| Status | The subscriber's status. Options: "Enabled", "Disabled", "Blocklisted". |
| Lists | JSON array specifying the mailing lists to which the subscriber should be added. |
| Attributes | JSON object containing custom attributes related to the subscriber. |
| Preconfirm Subscriptions | Boolean flag indicating whether subscriptions are preconfirmed (true) or require double opt-in confirmation (false). |
Output
The node outputs JSON data representing the result of the modification operation on the subscriber. This typically includes updated subscriber details such as their ID, email, status, list memberships, and any attributes. The output structure mirrors the subscriber resource schema used by the Listmonk API.
If binary data were involved (not indicated here), it would represent attachments or media related to the subscriber, but this operation focuses solely on JSON subscriber data.
Dependencies
- Requires connection to a Listmonk instance via its REST API.
- Needs credentials including domain URL, username, and password for basic authentication.
- The node expects the Listmonk API to be accessible at the configured base URL under
/api.
Troubleshooting
- Invalid Subscriber ID: If the provided subscriber ID does not exist, the API will likely return an error indicating the subscriber was not found. Verify the ID before attempting modification.
- Authentication Errors: Incorrect credentials or domain URL will cause authentication failures. Ensure the API credentials and domain are correctly configured.
- Malformed JSON for Lists or Attributes: Since these fields expect JSON input, invalid JSON syntax will cause errors. Validate JSON formatting before submission.
- Status Value Issues: Only the specified status options ("enabled", "disabled", "blocklisted") are accepted. Using unsupported values will result in errors.
- Preconfirm Subscriptions Flag: Misunderstanding this flag may lead to unexpected subscription confirmation behavior. Set it according to whether you want to bypass double opt-in emails.
Links and References
- Listmonk Official Documentation
- Listmonk API Reference (for subscriber management endpoints)