Skip to content

Delete Chat Bot

DELETE
/webchat/chat-bots/{bot_id}

Delete a chat bot, and with it the content that belongs to it.

Deleting the bot a live embed points at takes that widget down. Check which bot is default with GET /webchat/chat-bots first.

Authorizations

Parameters

Path Parameters

bot_id
required

Chat bot id (UUID).

string

Chat bot id (UUID).

Query Parameters

expected_revision
Any of:
integer
>= 1

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

Header Parameters

X-Target-Org-Id
Any of:
string

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