Skip to main content
PATCH
Update Group

Authorizations

Authorization
string
header
required

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

Path Parameters

group_id
string<uuid>
required

Body

application/json
name
string | null
Required string length: 1 - 64
description
string | null
currency
string | null
default_leverage
integer | null
Required range: 1 <= x <= 1000
margin_call_level
number | null
Required range: 20 <= x <= 500
stopout_level
number | null
Required range: 5 <= x <= 80
commission_type
string | null
commission_value
number | null
Required range: 0 <= x <= 50
swap_enabled
boolean | null
swap_multiplier
number | null
Required range: 0.01 <= x <= 10
swap_free
boolean | null
swap_free_days
integer | null
Required range: 0 <= x <= 365
is_islamic
boolean | null
max_exposure
number | null
Required range: x >= 0
net_max_exposure
boolean | null
max_open_positions
integer | null
Required range: x >= 1
is_default
boolean | null
is_active
boolean | null

Response

Successful Response

id
string<uuid>
required
name
string
required
description
string | null
required
currency
string
required
default_leverage
integer
required
margin_call_level
number
required
stopout_level
number
required
commission_type
string
required
commission_value
number
required
swap_enabled
boolean
required
swap_multiplier
number
required
swap_free
boolean
required
swap_free_days
integer
required
is_islamic
boolean
required
is_default
boolean
required
is_active
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
max_exposure
number | null
net_max_exposure
boolean
default:false
max_open_positions
integer | null