Skip to content

Update Chat Bot

PATCH
/webchat/chat-bots/{bot_id}

Rename a chat bot. name is required - it is the only mutable field.

Authorizations

Parameters

Path Parameters

bot_id
required

Chat bot id (UUID).

string

Chat bot id (UUID).

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Rename a chat bot.

name is REQUIRED even though this is a PATCH - it is the only mutable field, and the app’s model requires it. expected_revision is the optimistic-concurrency check: send the revision you read, and a concurrent edit comes back 409 rather than silently overwriting.

object
expected_revision
Any of:
integer
>= 1
name
required
string
>= 1 characters <= 120 characters

Responses

200

Successful Response

object
data
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.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string