Branding Settings

Use to manage branding settings for your organization.

Get branding settings

get

Returns all branding-related settings for the tenant.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Responses

200

Executed successfully.

application/json

Aggregated response containing all branding settings configured for the tenant

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/branding/settings

HTTPcURLJavaScriptPython

GET /api/v1/branding/settings HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "logo": {
    "value": {
      "logo": "<base64-encoded-image>"
    },
    "displayName": "Logo",
    "description": "Retrieve the base64 logo file."
  }
}

Get branding setting by key

get

Returns a single branding setting identified by the path key.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

keystring · enumRequired

Identifier of the branding setting to retrieve or update

Possible values:

Responses

200

Executed successfully.

application/json

objectOptional

Dynamic settings response that varies by setting key

400

Bad request.

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/branding/settings/{key}

HTTPcURLJavaScriptPython

GET /api/v1/branding/settings/{key} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "value": {
    "logo": "<base64-encoded-image>"
  },
  "displayName": "Logo",
  "description": "Retrieve the base64 logo file."
}

Update branding setting by key

put

Updates a single branding setting identified by the path key.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

keystring · enumRequired

Identifier of the branding setting to retrieve or update

Possible values:

Body

application/json

Responses

200

Setting successfully updated.

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

413

Request entity too large

application/json

415

Unsupported media type

application/json

500

unexpected error

application/json

503

unexpected error

application/json

put

/api/v1/branding/settings/{key}

HTTPcURLJavaScriptPython

PUT /api/v1/branding/settings/{key} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/x8AAwMCAO+V4nEAAAAASUVORK5CYII="
}

No content