Web Chat

Update Webchat Question

Partial edit of a preset question. chat_bot_id locates the row.

patch/webchat/questions/{question_id}

Request

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

Path parameters

question_idstring required

Question id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

chat_bot_idstring required

Owning chat bot id (UUID).

questionstring nullable
categorystring nullable
pathsstring[] nullable
activeboolean nullable
surface'external' | 'internal' nullable
expected_revisioninteger nullable
placementsstring[] nullable
sort_orderinteger 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.