Update Webchat Agent
PATCH /webchat/agents/{agent_id}
PATCH
/webchat/agents/{agent_id}
Partial edit of an agent mapping.
chat_bot_id is required in the body and is not a field being changed - it
is how the row is FOUND, because agent ids are unique per bot.
Authorizations
Parameters
Path Parameters
agent_id
required
Agent row id.
string
Agent row id.
Header Parameters
Request Body required
Partial edit of an agent mapping. chat_bot_id stays required.
It is not a field being changed - it is how the app FINDS the row, because agent ids are unique per bot rather than per org.
object
chat_bot_id
required
Owning chat bot id (UUID).
string
url_filter
Any of:
Array<string>
null
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
notes
Any of:
Array<string>
null
page
required
Current page number (1-indexed)
integer
total
required
Total number of items
integer
null
422
Validation Error
object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string