Set Demo Halt
Halt or resume trading for a risk category on Demo.
Available to: Organization administrators (risk categories in their organization)
Environments: Demo
Rate Limit: 20 requests per hour, 5-second back-off, counts all requests
Halt trading for every account assigned to a risk category, or resume it. Pass the riskCategoryId and set halt to true to halt or false to resume. Trading stays halted until you resume it. If the risk category is already in the state you request, the call succeeds without changing anything.
To find your risk category IDs, call riskCategoryList.
Common Failure Scenarios
- The request is sent to Live. This returns
HTTP 200with"Demo only"inerrorTextandok: false. - The caller isn’t an organization administrator. This returns
HTTP 401with"mustBeOrganizationAdmin". - No risk category matches
riskCategoryId, or the caller can’t access it. Both returnHTTP 404with an empty body. - The caller’s user type, or the API key’s permissions, don’t include full access to the
Risksresource. This returnsHTTP 401with"Access is denied". riskCategoryIdisn’t greater than 0. This returnsHTTP 400.
This endpoint returns HTTP 200 for both successful and rejected requests, so check the ok field to confirm the result (a response with ok: false means the request was rejected). Other failures, such as denied access or an invalid request, return their own HTTP status.
Error Messages
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
Response
Non-empty if the request failed