User Cancellation

Overview

Aside from revoking trading permissions, should a user terminate their use of your service you can cancel all of their subscriptions and entitlements within your organization. To do so you can use the user/cancelEverything endpoint.


Call CancelEverything from Both Trading Environments

Remember that you must call this endpoint from both the demo and live domains (or demo-api and live-api in staging)

Live

$curl -X POST "https://demo.tradovateapi.com/v1/user/canceleverything" \
>-H "Authorization: Bearer <your_access_token>" \
>-H "Content-Type: application/json" \
>-d '{"userIds": [12345, 67890]}'

Demo

$curl -X POST "https://live.tradovateapi.com/v1/user/canceleverything" \
>-H "Authorization: Bearer <your_access_token>" \
>-H "Content-Type: application/json" \
>-d '{"userIds": [12345, 67890]}'

Optional Parameters

You can also pass in the following optional parameters to control which entities are cancelled:

  • tradovateSubscriptions (boolean, optional) - Whether to cancel tradovate subscriptions
  • userPlugins (boolean, optional) - Whether to cancel user plugins
  • marketDataSubscriptions (boolean, optional) - Whether to cancel market data subscriptions
  • tradingPermissions (boolean, optional) - Whether to cancel trading permissions

For example, to cancel only tradovate subscriptions and trading permissions, you can do the following:

$curl -X POST "https://demo.tradovateapi.com/v1/user/canceleverything" \
>-H "Authorization: Bearer <your_access_token>" \
>-H "Content-Type: application/json" \
>-d '{"userIds": [12345, 67890], "tradovateSubscriptions": true, "tradingPermissions": true, "userPlugins": false, "marketDataSubscriptions": false}'
$curl -X POST "https://live.tradovateapi.com/v1/user/canceleverything" \
>-H "Authorization: Bearer <your_access_token>" \
>-H "Content-Type: application/json" \
>-d '{"userIds": [12345, 67890], "tradovateSubscriptions": true, "tradingPermissions": true, "userPlugins": false, "marketDataSubscriptions": false}'