Skip to content
campaiDeveloper
campai.com

Organizations

GET/connect/organizations/{organizationId}/brand/chat-styleReads only

Get default chat appearance

Returns the default appearance inherited by team chats without a custom appearance, or null for the app default

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Permission checks in detail
Required permissions
  • organization.read

Request

Path parameters

  • organizationIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request GET 'https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/brand/chat-style' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • lightobjectnullable
    4 properties
    • backgroundobject
    • incomingobject
      2 properties
      • backgroundColorstring

        pattern ^#[0-9a-fA-F]{6}$

      • textColorstring

        pattern ^#[0-9a-fA-F]{6}$

    • outgoingobject
      2 properties
      • backgroundColorstring

        pattern ^#[0-9a-fA-F]{6}$

      • textColorstring

        pattern ^#[0-9a-fA-F]{6}$

    • accentobject
      3 properties
      • backgroundColorstring

        pattern ^#[0-9a-fA-F]{6}$

      • textColorstring

        pattern ^#[0-9a-fA-F]{6}$

      • foregroundColorstring

        pattern ^#[0-9a-fA-F]{6}$

  • darkobjectnullable
    4 properties
    • backgroundobject
    • incomingobject
      2 properties
      • backgroundColorstring

        pattern ^#[0-9a-fA-F]{6}$

      • textColorstring

        pattern ^#[0-9a-fA-F]{6}$

    • outgoingobject
      2 properties
      • backgroundColorstring

        pattern ^#[0-9a-fA-F]{6}$

      • textColorstring

        pattern ^#[0-9a-fA-F]{6}$

    • accentobject
      3 properties
      • backgroundColorstring

        pattern ^#[0-9a-fA-F]{6}$

      • textColorstring

        pattern ^#[0-9a-fA-F]{6}$

      • foregroundColorstring

        pattern ^#[0-9a-fA-F]{6}$

Response200
{
  "light": {
    "background": {
      "kind": "gradient",
      "colors": [
        "string"
      ],
      "position": 0,
      "animated": true,
      "speed": 0.25,
      "pattern": {
        "assetId": "string",
        "opacity": 0,
        "scale": 0.5,
        "mode": "overlay"
      }
    },
    "incoming": {
      "backgroundColor": "string",
      "textColor": "string"
    },
    "outgoing": {
      "backgroundColor": "string",
      "textColor": "string"
    },
    "accent": {
      "backgroundColor": "string",
      "textColor": "string",
      "foregroundColor": "string"
    }
  },
  "dark": {
    "background": {
      "kind": "gradient",
      "colors": [
        "string"
      ],
      "position": 0,
      "animated": true,
      "speed": 0.25,
      "pattern": {
        "assetId": "string",
        "opacity": 0,
        "scale": 0.5,
        "mode": "overlay"
      }
    },
    "incoming": {
      "backgroundColor": "string",
      "textColor": "string"
    },
    "outgoing": {
      "backgroundColor": "string",
      "textColor": "string"
    },
    "accent": {
      "backgroundColor": "string",
      "textColor": "string",
      "foregroundColor": "string"
    }
  }
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.