Save the white label settings

POST /api/2.0/settings/whitelabel/save

Request

Saves the white label settings specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Query

IsDarkboolean

Specifies if the logo is for a dark theme or not

IsDefaultboolean

Specifies if the logo is for a default tenant or not

Body

Request parameters for white label settings

logoTextstring

Logo text

logoarray of object

Tenant IDs with their logos (light or dark)

keystring

valueobject

lightstring

Light theme logo

darkstring

Dark theme logo

Examples

POST /api/2.0/settings/whitelabel/save?IsDark=true&IsDefault=true HTTP/1.1
Accept: application/json
Content-Length: 202
Content-Type: application/json
Host: example.com

{
  "logoText": "some text",
  "logo": [
    {
      "value": {
        "key": "some text",
        "value": {
          "light": "some text",
          "dark": "some text"
        }
      }
    }
  ]
}

curl --request POST \
  --url 'https://example.com/api/2.0/settings/whitelabel/save?IsDark=true&IsDefault=true' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "logoText": "some text",
  "logo": [
    {
      "value": {
        "key": "some text",
        "value": {
          "light": "some text",
          "dark": "some text"
        }
      }
    }
  ]
}'

Responses

200

Boolean value: true if the operation is sucessful

401

Unauthorized

403

No permissions to perform this action