Organizations
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'const response = await fetch("https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/brand/chat-style", {
method: "GET",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'GET',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/brand/chat-style', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
Response
200 Successful response
Content-Type: application/json
-
lightobjectnullable4 properties
-
backgroundobject -
incomingobject2 properties
-
backgroundColorstringpattern
^#[0-9a-fA-F]{6}$ -
textColorstringpattern
^#[0-9a-fA-F]{6}$
-
-
outgoingobject2 properties
-
backgroundColorstringpattern
^#[0-9a-fA-F]{6}$ -
textColorstringpattern
^#[0-9a-fA-F]{6}$
-
-
accentobject3 properties
-
backgroundColorstringpattern
^#[0-9a-fA-F]{6}$ -
textColorstringpattern
^#[0-9a-fA-F]{6}$ -
foregroundColorstringpattern
^#[0-9a-fA-F]{6}$
-
-
-
darkobjectnullable4 properties
-
backgroundobject -
incomingobject2 properties
-
backgroundColorstringpattern
^#[0-9a-fA-F]{6}$ -
textColorstringpattern
^#[0-9a-fA-F]{6}$
-
-
outgoingobject2 properties
-
backgroundColorstringpattern
^#[0-9a-fA-F]{6}$ -
textColorstringpattern
^#[0-9a-fA-F]{6}$
-
-
accentobject3 properties
-
backgroundColorstringpattern
^#[0-9a-fA-F]{6}$ -
textColorstringpattern
^#[0-9a-fA-F]{6}$ -
foregroundColorstringpattern
^#[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.