Close

Removes the direct message from the user's list of direct messages.

URLRequires AuthHTTP Method

/api/v1/im.close

yes

POST

Payload

ArgumentExampleRequiredDescription

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

VersionDescription

0.48.0

Added

Last updated

Rocket.Chat versions receive support for six months after release.