Home B2Core API REST API The Front Office API Client settings

Client settings

Use these methods to manage client settings.

GET[host]/api/v2/my/settings

Get client settings

PUT[host]/api/v2/my/settings

Update client settings

Get client settings

Use this method to get settings configured for the currently authenticated client.

Request

Header parameters:

  • Authorization: Bearer <access_token>

GET[host]/api/v2/my/settings

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

Response

A response contains a Client Settings objects providing information about the settings configured for a client.

Update client settings

Use this method to change settings configured for the currently authenticated 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>

Body:

The following field values can be updated:

settings object required

The object containing the following fields:

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.

commonTheme string

The default theme applied to the B2Core UI. Possible values:

  • dark-theme

  • light-theme

PUT[host]/api/v2/my/settings

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