Expire User Lockout

Expire a user’s manual trading lockout.

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:

• Trading is re-enabled immediately across all accounts tied to the user
• The lockout record is updated with the administrator’s action and notes

Common Failure Scenarios

• The caller isn’t an organization administrator
• The user doesn’t belong to the caller’s organization
• The user doesn’t have an active lockout

All responses return HTTP 200. Errors are indicated by ok: false and an errorText field in the response body.

Error Messages

Related Endpoints

• Use expireAccountLockout to unlock a single account (organization administrators only)
• Use expireAllAccountLockouts to unlock all accounts for a user (organization administrators only)
• Use accountLockoutStatus to check whether accounts are currently locked