Actions71
- Settings Actions
- Subscribers Actions
- Create Subscriber
- Manage Subscriber Lists By Query
- Get Subscribers
- Delete Subscriber By List
- Get Subscriber By Id
- Update Subscriber By Id
- Delete Subscriber By Id
- Manage Subscriber Lists
- Manage Subscriber List By Id
- Manage Blocklist By Subscriber List
- Manage Blocklist Subscribers By Id
- Export Subscriber Data By ID
- Get Subscriber Bounces By Id
- Delete Subscriber Bounces By Id
- Subscriber Send Optin By Id
- Delete Subscriber By Query
- Blocklist Subscribers Query
- Bounces Actions
- Import Actions
- Campaigns Actions
- Update Preview Campaign By Id
- Get Campaigns
- Create Campaign
- Get Campaign By Id
- Update Campaign By Id
- Delete Campaign By Id
- Get Running Campaign Stats
- Get Campaign Analytics
- Preview Campaign By Id
- Preview Campaign Text By Id
- Update Campaign Status By Id
- Update Campaign Archive By Id
- Create Campaign Content By Id
- Test Campaign By Id
- Media Actions
- Templates Actions
- Public Actions
- Miscellaneous Actions
- Admin Actions
- Logs Actions
- Lists Actions
- Transactional Actions
- Maintenance Actions
Overview
This node operation manages subscriber lists in the Listmonk system. It allows users to add, remove, or unsubscribe subscribers from specified lists based on their IDs. This is useful for bulk managing subscriber statuses and list memberships, such as adding new subscribers to marketing lists, removing inactive users, or unsubscribing users who opt out.
Use Case Examples
- Add multiple subscribers to a promotional email list by specifying their IDs and the target list ID.
- Remove subscribers from a list when they no longer wish to receive communications.
- Unsubscribe users from all lists to comply with their opt-out requests.
Properties
| Name | Meaning |
|---|---|
| Query | A string query parameter sent in the request body, potentially used for filtering or searching subscribers. |
| Ids | A JSON array of subscriber IDs to be modified (added, removed, or unsubscribed). |
| Action | The action to perform on the subscribers: add them to lists, remove them from lists, or unsubscribe them. |
| Target List Ids | An array of list IDs that the subscribers will be added to, removed from, or unsubscribed from. |
| Status | The status to set for the subscribers, such as confirmed, unconfirmed, or unsubscribed. |
| Request Options | Additional request settings including batching (to throttle requests), SSL certificate validation, proxy configuration, and request timeout. |
Output
JSON
success- Indicates if the subscriber list management operation was successful.modifiedCount- Number of subscribers successfully modified.errors- Details of any errors encountered during the operation.
Dependencies
- Requires an API key credential for authenticating with the Listmonk API.
Troubleshooting
- Ensure the subscriber IDs and list IDs are valid and exist in the Listmonk system to avoid errors.
- Check network connectivity and proxy settings if requests fail or time out.
- If SSL certificate validation fails, consider enabling the option to ignore SSL issues, but be aware of security risks.
- Batching settings should be adjusted carefully to avoid overwhelming the API or hitting rate limits.
Links
- Listmonk API Documentation - Official documentation for the Listmonk API, useful for understanding available endpoints and request formats.