PATCH
/
v0
/
chatbots
/
{chatbotId}
/
appearance
{
  "success": true,
  "message": "Updated the chatbot  appearance successfully",
  "data": {}
}

Authorizations

​
Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
chatbotId
string
required

Id of the chatbot

Body

application/json

Request Body

​
title
string

Title of the chatbot

​
welcomeMessage
string

The first message that the users will see in the chatbot

​
placeholderText
string

Placeholder text that users see before they type their question in the chat

​
brandColor
string

Primary color of the chatbot

​
brandTextColor
string

Primary text color of the chatbot

​
fontSize
integer

Font size of the text shown in chatbot (in px)

​
height
number

Height of the chatbot

​
learnMore
string

Learn More localization setting of the chatbot

​
ctaText
string

Call to Action text

​
ctaLink
string

Call to Action link

​
watermarkText
string

Text to be shown as the watermark in the chatbot

​
watermarkLink
string

Url of the watermark to be shown in the chatbot

​
autoOpenChatWindowInDesktop
enum<string>

Option to handle behaviour auto open chat window in desktop

Available options:
ALWAYS_OPEN_WITH_DELAY,
DONT_OPEN
​
autoOpenChatWindowDelayInDesktop
integer

Delay after which the chat window will shown in desktop when autoOpenChatWindowInDesktop is set to AUTO_OPEN_WITH_DELAY

​
autoOpenChatWindowInMobile
enum<string>

Option to handle behaviour auto open chat window in mobile

Available options:
ALWAYS_OPEN_WITH_DELAY,
DONT_OPEN
​
autoOpenChatWindowDelayInMobile
integer

Delay after which the chat window will shown in mobile when autoOpenChatWindowInMobile is set to AUTO_OPEN_WITH_DELAY

​
hideWatermark
boolean

Indicates whether the watermark is shown in the chatbot or not

​
hideSources
boolean

Indicates whether to display sources or not in the chatbot

​
hideTooltip
boolean

Indicates whether to hide tooltip or not in the chatbot

​
hideFeedbackButtons
boolean

Indicates whether to hide feedback buttons (for each reply) or not in the chatbot

​
rtl
boolean

Indicates whether to display the text in the chatbot right to left or opposite

​
distanceFromBottom
integer

Distance from bottom (in px) where the chatbot icon should be shown

​
horizontalDistance
integer

Horizantal distance (in px) where the chatbot icon should be shown

​
iconSize
enum<string>

Possible options foe icon size of the chatbot

Available options:
SMALL,
MEDIUM,
LARGE,
XL,
2XL,
3XL,
4XL,
5XL
​
iconPosition
enum<string>

Possible options for icon position of the chatbot

Available options:
LEFT,
RIGHT

Response

200 - application/json

Success Response

​
success
boolean

Indicates whether this is success response or error response

​
message
string

Overall message regarding the operation performed

​
data
object | null

Data returned from the server

Was this page helpful?

Delete ChatbotModify Chatbot Custom Content