UPDATE
Update an existing chat theme by theme ID
post
https://api.eyelevel.ai/v1/partner
/theme/:apiKey/:themeId
UPDATE

Request

{
"theme": {
"name": "STRING",
"iconUrl": "STRING",
"logoUrl": "STRING",
"header": "STRING",
"responseBackground": "STRING",
"chatBackground": "STRING",
"responseText": "STRING",
"mainText": "STRING",
"headerText": "STRING",
"button": "STRING",
"buttonBackground": "STRING",
"bubbleBackground": "STRING",
"bubble": "STRING",
"bubbleIconUrl": "STRING",
"advancedCSS": "STRING",
"timing": FLOAT,
}
}

name

REQUIRED - String
Validation: 20 character limit
The human readable name for the theme.

iconUrl

OPTIONAL - String
Validation: A valid URL including protocol http(s)
The URL for the hosted image. This image will automatically be cropped to a circular shape.‌

logoUrl

OPTIONAL - String
Validation: A valid URL including protocol http(s)
The URL for the hosted image. If logoUrl is set, headerText is not applicable.‌
OPTIONAL - String
Validation: A valid hex color code
The header bar background color.

responseBackground

OPTIONAL - String
Validation: A valid hex color code
The background of the user chat text bubble.

chatBackground

OPTIONAL - String
Validation: A valid hex color code
The background color of the main chat window.

responseText

OPTIONAL - String
Validation: A valid hex color code
The secondary text color, including user chat text.

mainText

OPTIONAL - String
Validation: A valid hex color code
The primary text color, including server chat text.

headerText

OPTIONAL - String
Validation: 20 character limit
A human readable string that is displayed in the header bar of the chat experience. If logoUrl is set, headerText is not applicable.

button

OPTIONAL - String
Validation: A valid hex color code
Button text and border color.

buttonBackground

OPTIONAL - String
Validation: A valid hex color code
Button background color.

bubbleBackground

OPTIONAL - String
Validation: A valid hex color code
Chat bubble background color. A chat bubble will only appear for website integrations.

bubble

OPTIONAL - String
Validation: A valid hex color code
Chat bubble icon color. A chat bubble will only appear for website integrations.

bubbleIconUrl

OPTIONAL - String
Validation: A valid URL including protocol http(s)
The URL for the hosted image. If bubbleIconUrl is set, bubble color is not applicable.

advancedCSS

OPTIONAL - String
Validation: CSS
A string containing CSS information that will be applied without validation to chat experience and bubble.

timing

OPTIONAL - Float
Validation: A value between 0 and 15
The number of seconds before an alert appears beside the chat bubble. This attribute only applies to website chats.

Response

{
"message": "OK"
}

Objects

Last modified 1yr ago
Copy link
On this page
post
UPDATE
Request
name
iconUrl
logoUrl
header
responseBackground
chatBackground
responseText
mainText
headerText
button
buttonBackground
bubbleBackground
bubble
bubbleIconUrl
advancedCSS
timing
Response
Objects