Put Livechat Room on Hold

Put an active Livechat conversation on hold.
HTTP Method
URL
Requires Auth
POST
/api/v1/livechat/room.onHold
​yes​
Body
Key
Example Value
Description
roomId*
Z7223PfNPwH7ihQPh
Active Livechat room ID.
Example Call
curl --location --request POST 'http://localhost:3000/api/v1/livechat/room.onHold \
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'
-d "roomId=Z7223PfNPwH7ihQPh"
Example Response
{
    "success": true
}

HTTP Method	URL	Requires Auth
`POST`	`/api/v1/livechat/room.onHold`	`yes`

Key	Example Value	Description
`roomId*`	`Z7223PfNPwH7ihQPh`	Active Livechat room ID.

Last modified 18d ago