Create or update account lockout
Activates a lockout on the specified account. Any existing lockout for the account is replaced.
Supported modes:
hours— lock for N hours (requireshoursfield)trading_day— lock until end of current CME trading daytimed— lock for a preset duration:15m,30m,1h, orall_day(requirestimed_duration)session— lock until a market session ends:ny,london, orcustom(requiressession, optionallysession_start/session_end/timezone)trade_clock— position-aware lockout that blocks NEW ENTRIES (submit order, reverse position) while the account has open exposure. Managing the live trade stays fully available: set/modify TP and SL (position brackets, modifying bracket children), attach/link/detach exits, cancel, close, and flatten all work.
For all modes except trade_clock, activating a lockout immediately flattens the account (closes positions + cancels orders) — warn the trader before activating one of these modes while they hold open positions.
During ANY active lockout, risk-reducing actions stay available: cancel order(s), close position(s), and flatten always work. A lockout blocks new risk, never the exit from existing risk.
Body
Lockout creation request
UUID of the trading account
"550e8400-e29b-41d4-a716-446655440000"
Lockout mode: hours, trading_day, timed, session, trade_clock
"timed"
Legacy duration field for mode=hours
3
Human-readable reason for the lockout. Defaults to "Initiated by user".
"Initiated by user"
Session selection for mode=session: ny, london, custom
"ny"
Custom session end in HH:MM (24h), required when session=custom
"16:00"
Custom session start in HH:MM (24h), required when session=custom
"09:30"
Preset duration for mode=timed: 15m, 30m, 1h, all_day
"30m"
Optional IANA timezone for custom sessions (defaults to America/New_York)
"America/New_York"
Related topics
Create admin lockoutUpdate active lockoutCreate or update a copy trading configUpdate a webhookUpdate notification preferences