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 subscribers in a subscriber list by its ID within the Listmonk system. It allows users to add, remove, or unsubscribe subscribers from a specified list, modify subscriber statuses, and target specific subscriber IDs or lists. This is useful for automating subscriber management tasks such as updating mailing lists, segmenting subscribers, or handling subscription statuses programmatically.
Use Case Examples
- Add multiple subscribers to a mailing list by specifying their IDs and the target list ID.
- Remove subscribers from a list by providing their subscriber IDs and the list ID.
- Unsubscribe users from a list to stop sending them emails without deleting their data.
Properties
| Name | Meaning |
|---|---|
| Id | The ID of the subscriber list to update. |
| Query | A query string to filter or specify subscribers (usage context dependent). |
| Ids | The IDs of the subscribers to be modified (added, removed, or unsubscribed). |
| Action | The action to perform on the subscribers: add, remove, or unsubscribe. |
| Target List Ids | The IDs of the target lists to be modified (used when moving or copying subscribers). |
| Status | The subscription status to set for the subscribers: confirmed, unconfirmed, or unsubscribed. |
| Request Options | Additional request options such as batching, SSL certificate handling, proxy settings, and timeout configuration. |
Output
JSON
success- Indicates if the subscriber management operation was successful.message- Additional information or status message returned from the API.
Dependencies
- Requires an API key credential for authenticating with the Listmonk API.
Troubleshooting
- Ensure the list ID and subscriber IDs are valid and exist in the Listmonk system to avoid errors.
- Check API credentials and base URL configuration if authentication fails.
- If SSL certificate validation errors occur, consider enabling the option to ignore SSL issues, but only if safe to do so.
- Batching options should be configured carefully to avoid rate limiting or timeouts.
Links
- Listmonk API Documentation - Official API documentation for Listmonk, detailing endpoints and usage.