Skip to content

Update Webchat Button

PATCH
/webchat/buttons/{button_id}

Partial edit of a button. chat_bot_id locates the row.

Authorizations

Parameters

Path Parameters

button_id
required

Button id.

string

Button id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Partial edit of a button. chat_bot_id locates the row.

object
action
Any of:
string
Allowed values: link question calendar
active
Any of:
boolean
category
Any of:
string
>= 1 characters <= 100 characters
chat_bot_id
required

Owning chat bot id (UUID).

string
expected_revision
Any of:
integer
>= 1
icon
Any of:
string
<= 100 characters
label
Any of:
string
>= 1 characters <= 255 characters
paths
Any of:
Array<string>
surface
Any of:
string
Allowed values: external internal
value
Any of:
string
>= 1 characters <= 1000 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