POST Chat
Reset Room
This removes all events from the room and resets any counters.
This removes all events from the room and resets any counters. The purpose of this function is to reset the room back to a clean state after using it for testing purposes
URL Arguments
- roomid : (required) The ID of the room
POST BODY Arguments
- removeusereffects : (optional | false) If true, all effects applied to users in this room are removed from this room only
Request
Parameters
Values in the path and query string.
appid path string TalkLabs ID required
The TalkLabs application ID assigned to your account.
Example:your-app-id RoomId path string TalkLabs ID required
The TalkLabs assigned room ID returned when the room was created.
Example:room-id Request
JSON body
Send as application/json.
removeUserEffects boolean
Request example
{} Response
Status codes
Every JSON response uses the API result envelope.
200 OK ApiResult 400 Bad Request ApiResult 403 Forbidden ApiResult 404 Not Found ApiResult 500 Internal Server Error ApiResult Example response · 200
{
"message": "The specified conversation and all comments were permanently deleted.",
"errors": {},
"data": {
"kind": "delete.conversation",
"conversationid": "api-conversation-demo1",
"userid": null,
"deletedconversations": 1,
"deletedcomments": 17
}
}