B2Core API REST API The Back Office API Client settings

Client settings

Use this method to manage client settings and set limits to the number of trading accounts that each client can open.

GET[host]/api/v2/clients/{clientId}/limits	Get client limits
GET[host]/api/v2/clients/{clientId}//settings	Get client settings
PUT[host]/api/v2/clients/{clientId}/limits PATCH[host]/api/v2/clients/{clientId}/limits	Update client limits
PUT[host]/api/v2/clients/{clientId}/settings PATCH[host]/api/v2/clients/{clientId}/settings	Update client settings

Get client limits

Use this method to get the limits set for a specified client to the number of live and demo trading accounts that this client can create.

Request

Header parameters:

• Authorization: Bearer <access_token>

Path parameters:

clientId required

The client identifier.

GET[host]/api/v2/clients/{clientId}/limits

curl --location --request GET 'https://host.names/api/v2/clients/1/limits' \
--header 'Authorization: Bearer <token>'

Response

A response includes a Client Limits object providing information about the limits to the number of trading accounts set for a specified client.

Get client settings

Use this method to get settings configured for a specified client.

Request

Header parameters:

• Authorization: Bearer <access_token>

Path parameters:

clientId required

The client identifier.

GET[host]/api/v2/clients/{clientId}/settings

curl --location --request GET 'https://host.name/api/v2/clients/1/settings' \
--header 'Authorization: Bearer <token>'

Response

A response includes a Client Settings object providing information about the settings configured for a specified client.

Update client limits

Use this method to change the limits set for a specified client to the number of live and demo trading accounts that this client can open.

Note

Instead of the method described below, you can use a similar method that uses the HTTP verb PATCH.

Request

Header parameters:

• Authorization: Bearer <access_token>

Path parameters

clientId required

The client identifier.

Body:

The following field values can be updated:

maxDemoTradingAccounts string

The maximum number of demo trading accounts.

maxLiveTradingAccounts integer

The maximum number of live trading accounts.

PUT[host]/api/v2/clients/{clientId}/limits

curl --location --request PUT 'https://host.name/api/v2/clients/1/limits' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "maxDemoTradingAccounts": 3,
  "maxLiveTradingAccounts": 5
}'

Response

A response includes a Client Limits object providing information about the limits that were updated for a specified client.

Update client settings

Use this method to change settings configured for a specified client.

Note

Instead of the method described below, you can use a similar method that uses the HTTP verb PATCH.

Request

Header parameters:

• Authorization: Bearer <access_token>

Path parameters

clientId required

The client identifier.

Body:

The following field values can be updated:

applicationColor string

The color used to highlight client requests in the Back Office. You can specify the color name, or define its HEX or RGBA value.

locale string

The locale identifier (such as en_US) indicating a preferred communication language for a client.

PUT[host]/api/v2/clients/{clientId}/settings

curl --location --request PUT 'https://host.name/api/v2/clients/1/settings' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "settings": {
     "locale": "en_US",
     "applicationColor": "#225577"
  }
}'

Response

A response includes a Client Settings object providing information about the client settings that were updated.