THEME
Style information for chat experience themes
Themes apply to chat flows for every marketing channel except Facebook and Instagram. The branding for chats on Facebook and Instagram are configured using Facebook and Instagram page administrator settings.

Request

1
{
2
"name": "STRING",
3
"iconUrl": "STRING",
4
"logoUrl": "STRING",
5
"header": "STRING",
6
"responseBackground": "STRING",
7
"chatBackground": "STRING",
8
"responseText": "STRING",
9
"mainText": "STRING",
10
"headerText": "STRING",
11
"button": "STRING",
12
"buttonBackground": "STRING",
13
"bubbleBackground": "STRING",
14
"bubble": "STRING",
15
"bubbleIconUrl": "STRING",
16
"advancedCSS": "STRING",
17
"timing": FLOAT,
18
}
Copied!

Response

1
{
2
"themeId": INTEGER IDENTIFIER,
3
"name": "STRING",
4
"iconUrl": "STRING",
5
"logoUrl": "STRING",
6
"header": "STRING",
7
"responseBackground": "STRING",
8
"chatBackground": "STRING",
9
"responseText": "STRING",
10
"mainText": "STRING",
11
"headerText": "STRING",
12
"button": "STRING",
13
"buttonBackground": "STRING",
14
"bubbleBackground": "STRING",
15
"bubble": "STRING",
16
"bubbleIconUrl": "STRING",
17
"advancedCSS": "STRING",
18
"timing": FLOAT,
19
"updated": DATETIME
20
}
Copied!

Meta Attributes

headerText

A human readable string that is displayed in the header bar of the chat experience. If logoUrl is set, headerText is not applicable.

name

The human readable name for the theme.

themeId

The unique integer identifier for the theme which is generated while creating the theme.

timing

The number of seconds before an alert appears beside the chat bubble. This attribute only applies to website chats.

updated

The datetime the chat theme was created in RFC3339 format.

Image Icons

Custom images can be used in some places within the chat.

iconUrl

The URL for the hosted image. This image will automatically be cropped to a circular shape.

logoUrl

The URL for the hosted image. If logoUrl is set, headerText is not applicable.

bubbleIconUrl

The URL for the hosted image. If bubbleIconUrl is set, bubble color is not applicable.

Theme Colors

Themes can be customized and created by setting hex color codes for a pre-defined set of elements. Themes can also be customized using CSS. Keep in mind, there is no validation on custom CSS and invalid CSS may break your chats.
The hex color code for the header bar background color.

chatBackground

The hex color code for the background color of the main chat window.

mainText

The hex color code for the primary text color, including server chat text.

responseText

The hex color code for the secondary text color, including user chat text.

responseBackground

The hex color code for the background of the user chat text bubble.

button

The hex color code for the button text and border color.

buttonBackground

The hex color code for the button background color.

bubble

The hex color code for the chat bubble icon color. A chat bubble will only appear for website integrations.

bubbleBackground

The hex color code for the chat bubble background color. A chat bubble will only appear for website integrations.

advancedCSS

A string containing CSS information that will be applied without validation to chat experience and bubble.
Last modified 11mo ago