Skip to main content
PATCH
Patch symbol control

Authorizations

Authorization
string
header
required

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

Path Parameters

account_id
string<uuid>
required

Trading account ID

symbol
string
required

Symbol

Body

application/json

Fields to change, and fields to remove

clear
enum<string>[]

Fields to remove. Clearing manually_disabled restores its default of false, since the column cannot be null.

Fields of a manual control a PATCH may remove.

An enum rather than free text so a misspelled name is rejected instead of silently doing nothing. A caller that believes it re-enabled an account and did not is the failure this exists to prevent.

Available options:
manually_disabled,
manual_reason
manual_reason
string | null
manually_disabled
boolean | null

Response

Symbol control patched

account_id
string<uuid>
required
created_at
string<date-time>
required
manually_disabled
boolean
required
organization_id
string<uuid>
required
symbol
string
required
updated_at
string<date-time>
required
version
integer<int64>
required
manual_reason
string | null