Web Chat

Update Webchat Handoff Pool User Scope

REPLACE which bots a person takes handoffs for. Empty list = every bot.

A replace, not a merge: bots left out of the list are dropped.

patch/webchat/handoff-pool/users/{user_id}/scope

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/webchat/handoff-pool/users/{user_id}/scope
  • Auth: HTTP bearer

Path parameters

user_idstring required

Member user id.

Query parameters

pool'external' | 'internal'

Pool to re-scope. Only external is accepted by the app: the internal pool is not per-bot.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

chat_bot_idsstring[]

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.