Web Chat

Update Webchat Button

Partial edit of a button. chat_bot_id locates the row.

patch/webchat/buttons/{button_id}

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/webchat/buttons/{button_id}
  • Auth: HTTP bearer

Path parameters

button_idstring required

Button id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

chat_bot_idstring required

Owning chat bot id (UUID).

labelstring nullable
action'link' | 'question' | 'calendar' nullable
valuestring nullable
iconstring nullable
categorystring nullable
pathsstring[] nullable
activeboolean nullable
surface'external' | 'internal' nullable
expected_revisioninteger 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.