Web Chat

Update Assessment

Partial edit of an assessment.

active: false takes it out of the widget without deleting it, which is the reversible way to retire one.

The concurrency field is revision here, not expected_revision. That is the app's spelling on this model alone and is mirrored deliberately - a tidier name would be a field the handler does not read, silently switching the check off.

patch/webchat/assessments/{assessment_id}

Request

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

Path parameters

assessment_idstring required

Assessment id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

namestring nullable
descriptionstring nullable
activeboolean nullable
surface'external' | 'internal' nullable
revisioninteger nullable

Revision you last read. See the note above on the name.

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.