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 deletes garbage collected (GC) subscribers of a specified type from the Listmonk system. It is useful for maintenance tasks where you want to clean up or remove subscribers that have been marked for garbage collection, helping to keep the subscriber database clean and efficient. For example, you might use this operation to delete unsubscribed or inactive subscribers that have been collected by the system's garbage collection process.
Use Case Examples
- Deleting all GC collected subscribers of type 'unsubscribed' to free up space and maintain database hygiene.
- Removing GC collected subscribers of a specific campaign type after the campaign has ended.
Properties
| Name | Meaning |
|---|---|
| Type | Specifies the type of GC collected subscribers to delete. |
| Request Options | Optional settings to control request behavior such as batching, SSL certificate validation, proxy usage, and timeout duration. |
Output
JSON
success- Indicates whether the deletion operation was successful.deletedCount- Number of GC subscribers deleted.message- Additional information or status message about the deletion operation.
Dependencies
- Requires an API key credential for authenticating with the Listmonk API.
Troubleshooting
- Ensure the 'Type' property is correctly specified; an incorrect or empty type may result in no subscribers being deleted or an error.
- If SSL certificate validation fails and 'Ignore SSL Issues' is not enabled, the request may be blocked; enable this option only if you trust the source.
- Proxy settings must be correctly configured if used; incorrect proxy details can cause request failures.
- Timeout settings should be adjusted based on network conditions; too short a timeout may abort valid requests.
Links
- Listmonk API Documentation - Official API documentation for Listmonk, providing details on available endpoints and operations including subscriber management.