Delete Watchlist Group
delete_watchlist_groupDelete a watchlist group by numeric ID. Optionally purge its securities from all other groups.
Instructions
Delete a watchlist group by id (numeric). Set purge=true to also remove its securities from all other groups. Returns upstream API response.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Watchlist group id | |
| purge | Yes | Whether to also remove the securities from other groups |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The deleted watchlist group ID (echoed from the request). | |
| deleted | Yes | Always `true` on success. |