Skip to navigation
REST API EndpointsRisks

Delete User Account Position Limit

View as Markdown

Delete a position limit from a user account.

Available to: All authenticated users

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Removes the UserAccountPositionLimit identified by userAccountPositionLimitId, the single required field in the request body. Because risk parameters are children of a position limit, deleting the limit removes the pre-trade rule it defines for the account. To delete an individual child constraint without removing the whole limit, use deleteUserAccountRiskParameter instead.

To find the userAccountPositionLimitId to delete, call userAccountPositionLimit/deps for the account.

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

  • userAccountPositionLimitId is missing.
  • The referenced position limit 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.
userAccountPositionLimitIdlongRequired

Response

DeleteResultResponse
errorTextstringOptional<=8192 characters

Non-empty if the request failed

successbooleanOptional