Expire User Lockout
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
Response
Non-empty if the request failed
Bearer authentication of the form Bearer <token>, where token is your auth token.
Non-empty if the request failed
Note: The expireAccountLockout and expireAllAccountLockouts endpoints replace expireUserLockout. expireUserLockout remains available for users on legacy mobile app versions.
Available to: Organization administrators
Environments: Demo
Rate Limit: No endpoint-specific limit
This endpoint allows you to immediately expire an active manual trading lockout for a user in your organization.
Traders use manual lockouts to pause their trading activity for a specified amount of time. Since traders can’t cancel their own lockouts, only an organization administrator can unlock their account before the lockout expires.
When the lockout is expired:
Common Failure Scenarios
All responses return HTTP 200. Errors are indicated by ok: false and an errorText field in the response body.
Error Messages
Related Endpoints
expireAccountLockout to unlock a single account (organization administrators only)expireAllAccountLockouts to unlock all accounts for a user (organization administrators only)accountLockoutStatus to check whether accounts are currently locked