Chatbot Appearance

Update Chatbot Appearance

Update appearance of the chatbot

patch/v0/chatbots/{chatbotId}/appearance

Request

  • Base URL: https://sitegpt.ai/api
  • URL: https://sitegpt.ai/api/v0/chatbots/{chatbotId}/appearance
  • Auth: HTTP bearer

Path parameters

chatbotIdstring required

Id of the chatbot

Request body

titlestring

Title of the chatbot

welcomeMessagestring

The first message that the users will see in the chatbot

placeholderTextstring

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

brandColorstring

Primary color of the chatbot

brandTextColorstring

Primary text color of the chatbot

fontSizeinteger

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

heightnumber

Height of the chatbot

learnMorestring

Learn More localization setting of the chatbot

ctaTextstring

Call to Action text

ctaLinkstring

Call to Action link

watermarkTextstring

Text to be shown as the watermark in the chatbot

watermarkLinkstring

Url of the watermark to be shown in the chatbot

autoOpenChatWindowInDesktop'ALWAYS_OPEN_WITH_DELAY' | 'DONT_OPEN'

Option to handle behaviour auto open chat window in desktop

autoOpenChatWindowDelayInDesktopinteger

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

autoOpenChatWindowInMobile'ALWAYS_OPEN_WITH_DELAY' | 'DONT_OPEN'

Option to handle behaviour auto open chat window in mobile

autoOpenChatWindowDelayInMobileinteger

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

hideWatermarkboolean

Indicates whether the watermark is shown in the chatbot or not

hideSourcesboolean

Indicates whether to display sources or not in the chatbot

hideTooltipboolean

Indicates whether to hide tooltip or not in the chatbot

hideFeedbackButtonsboolean

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

rtlboolean

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

distanceFromBottominteger

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

horizontalDistanceinteger

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

iconSize'SMALL' | 'MEDIUM' | 'LARGE' | 'XL' | '2XL' | '3XL' | '4XL' | '5XL'

Possible options foe icon size of the chatbot

iconPosition'LEFT' | 'RIGHT'

Possible options for icon position of the chatbot

Response

OK

successboolean

Indicates whether this is success response or error response

messagestring

Overall message regarding the operation performed

dataobject nullable

Data returned from the server

Changes

No recorded changes to this operation across all 1 revision of this API.