Links

Survey Livechat Room

Provide feedback on a Livechat room.
HTTP Method
URL
Requires Auth
POST
/api/v1/livechat/room.survey
no

Body

Key
Example Value
Description
rid*
JZ8Y2dLfYhsg323R
The room ID.
token*
d4a8338e5a7d98b6750b4f839431b34a3f4813b2c43f7d89597948f21f607bb4
The visitor token.
data*
"data": [ {
"name": "additionalFeedback", "value": "Thankszzzzz" } ]
An array of object with name and value to provide feedback.

Example Call

curl --location --request POST 'http://localhost:3000/api/v1/livechat/room.survey' \
--header 'Content-type: application/json' \
--data-raw '{
"rid": "gMMeBpWyLeowCrzBv",
"token": "d4a8338e5a7d98b6750b4f839431b34a3f4813b2c43f7d89597948f21f607bb4",
"data": [
{
"name": "additionalFeedback",
"value": "Thankszzzzz"
}
]
}'

Example Response

Success

{
"rid": "gMMeBpWyLeowCrzBv",
"data": {
"additionalFeedback": "Thankszzzzz"
},
"success": true
}

Error

Any of the following errors can occur on the endpoint.
  • Invalid token: When the visitor token provided is invalid.
  • Invalid Room: Occurs when the given rid is invalid.
Invalid token
{
"success": false,
"error": "[invalid-token]",
"errorType": "invalid-token"
}
Last modified 3mo ago
Rocket.Chat versions receive support for six months after release.