Skip to content

Add Webchat Handoff Pool Users

POST
/webchat/handoff-pool/users

Add people to the handoff pool. Returns the whole pool afterwards.

Adding someone already in it is a no-op, not an error. From the first member on, handed-off chats go ONLY to the pool.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

People to add to the handoff pool.

chat_bot_ids empty means EVERY bot. Non-empty is valid only for the external pool - the internal pool is not per-bot, and the app refuses the combination with a 422. Both lists are capped at 200 by the app to bound the per-person-per-bot rows one call can write.

object
chat_bot_ids
Array<string>
<= 200 items
pool
string
default: external
Allowed values: external internal
user_ids
required
Array<string>
>= 1 items <= 200 items

Responses

201

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