Skip to content

Delete Webchat Settings

DELETE
/webchat/settings

Delete the theme for one bot and surface.

The widget falls back to the defaults, which is a VISIBLE change to every visitor rather than a tidy-up.

Authorizations

Parameters

Query Parameters

chat_bot_id
required

Owning chat bot id (UUID). REQUIRED: an org can run several bots and this content belongs to one of them, so it identifies the rows rather than filtering them.

string

Owning chat bot id (UUID). REQUIRED: an org can run several bots and this content belongs to one of them, so it identifies the rows rather than filtering them.

surface
Any of:
string
Allowed values: external internal

Which widget: external (the customer-facing embed) or internal (graph8’s own support widget). Omitted means external.

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