Organization Admin Lock Account
Lock a subaccount to closing orders only.
Available to: Organization administrators
Environments: Live
Rate Limit: No endpoint-specific limit
Apply a partner lock to a subaccount in your own organization, putting it in liquidate-only mode (LiquidateOnlyModeImmediately): the account can close open positions but can’t open new ones. The lock is recorded with the PartnerPayoutLock reason code. You can pass an optional reason, stored with the lock and prefixed with Partner lock:.
A partner lock never overrides a stronger lock. The check reads the subaccount’s adminAction: if it’s already LockTradingImmediately or LiquidateImmediately, the request is rejected. Locking a subaccount that’s already in liquidate-only mode has no further effect, and returns the same shape as a successful lock — HTTP 200 carrying the account’s risk status, with no errorText.
NinjaTrader enables this feature per organization, so work with the NinjaTrader Support team to turn it on.
HTTP 200 with errorText set and no accountRiskStatus, not an error status. Check errorText to determine whether the lock succeeded.For the subaccount lifecycle, the effect on trading, and how this differs from Change Lock, see Partner Account Lock and Unlock.
Common Failure Scenarios
- The account isn’t a subaccount in your organization, or the feature isn’t enabled for your organization. The request is denied.
- The account’s
adminActionis alreadyLockTradingImmediatelyorLiquidateImmediately, which a partner lock can’t replace.
Error Messages
A failed request returns one of these messages:
Related Resources
- To reverse a partner lock or clear a risk lock, see
organizationAdminUnlockAccount. - To apply a partner lock or unlock using the Admin Dashboard, see Partner Account Lock and Unlock.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
Response
Non-empty if the request failed