Web Chat

Update Webchat Agent

Partial edit of an agent mapping.

chat_bot_id is required in the body and is not a field being changed - it is how the row is FOUND, because agent ids are unique per bot.

patch/webchat/agents/{agent_id}

Request

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

Path parameters

agent_idstring required

Agent row id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

chat_bot_idstring required

Owning chat bot id (UUID).

agent_idstring nullable
agent_namestring nullable
url_filterstring[] nullable
activeboolean nullable
defaultboolean 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.