Skip to navigation
REST API EndpointsRisks

Delete User Account Risk Parameter

View as Markdown

Delete a risk parameter from a position limit.

Available to: All authenticated users

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Removes the UserAccountRiskParameter identified by userAccountRiskParameterId, the single required field in the request body. A risk parameter is a child constraint of a UserAccountPositionLimit, so deleting it removes one pre-trade rule while leaving the parent position limit and its other parameters in place. To remove the entire position limit instead, use deleteUserAccountPositionLimit.

To find the userAccountRiskParameterId to delete, list the parameters of a position limit with userAccountRiskParameter/deps.

The endpoint returns a DeleteResultResponse with a success boolean and an errorText field that is non-empty only when the request fails. A failed deletion does not change the account’s risk configuration.

Common Failure Scenarios

  • userAccountRiskParameterId is missing.
  • The referenced risk parameter does not exist or is not visible to the calling user.

Error Messages

errorTextTrigger
Non-empty errorTextThe request failed; the field describes the reason.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
userAccountRiskParameterIdlongRequired

Response

DeleteResultResponse
errorTextstringOptional<=8192 characters

Non-empty if the request failed

successbooleanOptional