Web Chat

Update Webchat Settings

Partial edit of the theme. An unset field is left untouched.

THIS IS LIVE. A saved theme is what the next visitor sees, with no publish step in between.

To REMOVE a design-token override, list its path in themeOverridesRemove. Sending null for it does not remove it - under a partial update that reads as "leave it alone".

patch/webchat/settings

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/webchat/settings
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

chat_bot_idstring required

Owning chat bot id (UUID).

expected_revisioninteger nullable
surface'external' | 'internal' nullable
primaryColorstring nullable
secondaryColorstring nullable
fontFamilystring nullable
fontSizestring nullable
borderRadiusstring nullable
chatWidthstring nullable
darkModeboolean nullable
userMessageBgColorstring nullable
userMessageTextColorstring nullable
assistantMessageBgColorstring nullable
assistantMessageTextColorstring nullable
assistantNamestring nullable
showHeaderboolean nullable
headerTextColorstring nullable
showSuggestedQuestionsboolean nullable
showQuickActionsboolean nullable
suggestedQuestionsBgColorstring nullable
suggestedQuestionsSectionBgColorstring nullable
robotIconColorstring nullable
robotIconTypestring nullable
botIconTypestring nullable
headerImageUrlExternalstring nullable
headerImageUrlInternalstring nullable
botAvatarMode'agent' | 'preset' | 'custom' nullable
botAvatarPresetUrlstring nullable
botAvatarCustomUrlstring nullable
themeSource'default' | 'brand_kit' | 'custom' nullable
themeOverridesRemovestring[] nullable

Token paths to REMOVE. Unsetting a token is not the same as this.

copyOverridesobject nullable
launcherQuestionLimitinteger nullable
homeQuestionLimitinteger nullable
conversationQuestionLimitinteger nullable
conversationQuestionsAfterFirstMessage'hide' | 'remain' | 'collapse' nullable

Response

Successful Response

dataWebchatPayload required

An open envelope for one webchat object.

Open because the widget's config grows a field per product decision and a pinned schema would DROP it. Same choice the desk surface made.

Changes

No recorded changes to this operation across all 2 revisions of this API.