Web Chat

Update Webchat Blog

Partial edit of an article card. chat_bot_id locates the row.

patch/webchat/blogs/{blog_id}

Request

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

Path parameters

blog_idstring required

Article card id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

chat_bot_idstring required

Owning chat bot id (UUID).

urlstring nullable
titlestring nullable
descriptionstring nullable
image_urlstring nullable
pathsstring[] nullable
surface'external' | 'internal' nullable
activeboolean nullable
display_orderinteger 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.