Skip to navigation

Switch Risk Category

View as Markdown

Switch the active risk category for one or more accounts.

Available to: Organization administrators

Environments: Demo, Live

Rate Limit: 5,000 requests per hour, 1-second back-off, counts all requests

Use this endpoint to switch the risk category of up to 10,000 accounts in a single request. Accounts that already have the target risk category are skipped.

Risk categories are initially defined by your Template Account and applied at creation, but you can adjust risk categories after by contacting Eval Support.

To view the available risk categories for your organization, call /riskCategory/list.

Switch risk categories outside of trading hours or when affected accounts have no open positions. Switching risk categories re-evaluates open positions, potentially causing open positions to be auto-liquidated.

Common Failure Scenarios

  • "Empty accountIds": the accountIds array is empty
  • "Only 10000 accounts are allowed in single operation": the request exceeds the 10,000-account limit
  • The specified riskCategoryId does not exist (returns HTTP 404)
  • One or more account IDs do not exist (returns HTTP 404)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
accountIdslist of longsRequired
riskCategoryIdlongRequired

Response

SimpleResponse
okboolean
errorTextstringOptional<=8192 characters

Non-empty if the request failed