# OneSignal bulk unsubscribe This package can be used to unsubscribe multiple players (users) from your OneSignal app at once based on predefined filters, similar to how Segments work. OneSignal currently doesn`t provide any API endpoints for working with Segments nor updating players at once. With onesignal-bulk-unsubscribed you can easily unsubscribe players in one go and specify custom filters. **Caution!** Unsubscribing players is not a destructive job, you can still subscribe them again, but we do NOT provide a way to revert any changes. Use bulk unsubscribe with caution. ## Why There is an existing `onesignal-node` (package by zeyneloz)[https://github.com/zeyneloz/onesignal-node] but there are two main reasons why this package doesn't use it. * `onesignal-node` doesn't use an Agent for limiting number of open connections, unsubscribing thousands of players at once would simply be too much. This package uses `axios` with `httpsAgent` and `maxSockets` set to `10` to not consume all your computer's sockets. * `onesignal-node` is an API client, so it only gives out CSV URL, this package can download the CSV, including waiting for it being generated, ungzip it and parse it using `csvtojson` lib. ## How to install `npm install --save onesignal-bulk-unsubscribe` ## How to use ``` const bulkUnsubscribe = require('onesignal-bulk-unsubscribe') bulkUnsubscribe({ appId: '', // required restApiKey: '' // required filter: => , mutation: