Web Chat

Promote Chat Bot To Default

Make this the org's DEFAULT bot.

The default is what a legacy embed snippet with no bot id resolves to, so promoting one CHANGES WHAT LIVE VISITORS SEE on every such page - not just what the admin shows.

post/webchat/chat-bots/{bot_id}/promote-default

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/webchat/chat-bots/{bot_id}/promote-default
  • Auth: HTTP bearer

Path parameters

bot_idstring required

Chat bot id (UUID).

Query parameters

expected_revisioninteger nullable

Revision you last read. When given, a concurrent edit is a 409 instead of a silent overwrite.

Headers

Authorizationstring nullable
X-Target-Org-Idstring 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.