Expire User Lockout

View as Markdown
### Expire a user's manual trading lockout. ***Note***: The [`expireAccountLockout`](/api/rest-api-endpoints/users/expire-account-lockout) and [`expireAllAccountLockouts`](/api/rest-api-endpoints/users/expire-all-account-lockouts) endpoints replace [`expireUserLockout`](/api/rest-api-endpoints/users/expire-user-lockout). `expireUserLockout` remains available for users on legacy mobile app versions. **Available to:** Organization administrators **Environments:** Demo **[Rate Limit](/overview/core-concepts/rate-limits):** 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** | `errorText` | Trigger | |-------------|---------| | `"cannot expire lockout - no active lockout exists for user {userId}"` | The user doesn't have an active lockout | **Related Endpoints** - Use [`expireAccountLockout`](/api/rest-api-endpoints/users/expire-account-lockout) to unlock a single account (organization administrators only) - Use [`expireAllAccountLockouts`](/api/rest-api-endpoints/users/expire-all-account-lockouts) to unlock all accounts for a user (organization administrators only) - Use [`accountLockoutStatus`](/api/rest-api-endpoints/users/account-lockout-status) to check whether accounts are currently locked

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
userIdlongRequired
notesstringOptional<=8192 characters

Response

SimpleResponse
okboolean
errorTextstringOptional<=8192 characters

Non-empty if the request failed