Skip to main content
POST
Create or update account lockout

Body

application/json

Lockout creation request

account_id
string<uuid>
required

UUID of the trading account

Example:

"550e8400-e29b-41d4-a716-446655440000"

mode
string
required

Lockout mode: hours, trading_day, timed, session, trade_clock

Example:

"timed"

hours
integer<int64> | null

Legacy duration field for mode=hours

Example:

3

reason
string | null

Human-readable reason for the lockout. Defaults to "Initiated by user".

Example:

"Initiated by user"

session
string | null

Session selection for mode=session: ny, london, custom

Example:

"ny"

session_end
string | null

Custom session end in HH:MM (24h), required when session=custom

Example:

"16:00"

session_start
string | null

Custom session start in HH:MM (24h), required when session=custom

Example:

"09:30"

timed_duration
string | null

Preset duration for mode=timed: 15m, 30m, 1h, all_day

Example:

"30m"

timezone
string | null

Optional IANA timezone for custom sessions (defaults to America/New_York)

Example:

"America/New_York"

Response

Lockout created and enforced

Lockout status response

account_id
string<uuid>
required
active
boolean
required
ends_at
string | null
locked_by
string | null
mode
string | null
reason
string | null
remaining_minutes
integer<int64> | null
starts_at
string | null
trade_clock_active
boolean | null