Links
Comment on page

Close

Removes the direct message from the user's list of direct messages.
URL
Requires Auth
HTTP Method
/api/v1/im.close
yes
POST

Payload

Argument
Example
Required
Description
roomId
ByehQjC44FwMeiLbX
Required
The direct message 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/im.close \
-d '{ "roomId": "ByehQjC44FwMeiLbX" }'

Example Result

{
"success": true
}

Change Log

Version
Description
0.48.0
Added
Last modified 1yr ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.