Links

Close Group

Removes the group/channel from the user's list of groups, only if you're part of the group.
HTTP Method
URL
Requires Auth
POST
/api/v1/groups.close
yes

Body Parameters

Key
Example Value
Description
roomId*
HyehQjC44FwMeiLbX
The groups ID.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
-H "Content-type: application/json" \
http://localhost:3000/api/v1/groups.close \
-d '{
"roomId": "HyehQjC44FwMeiLbX" }'

Example Response

{
"success": true
}

Change Log

Version
Description
0.48.0
Added
Last modified 2mo ago
Rocket.Chat versions receive support for six months after release.