Unpins Message

Removes the pinned status of the provided chat message.

URLRequires AuthHTTP Method

/api/v1/chat.unPinMessage

yes

POST

Payload

ArgumentExampleRequiredDescription

messageId

7aDSXtjMA3KPLxLjt

Required

The message id to unpin.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type:application/json" \
     http://localhost:3000/api/v1/chat.unPinMessage \
     -d '{ "messageId": "7aDSXtjMA3KPLxLjt" }'

Example Result

{
    "success": true
}

Change Log

VersionDescription

0.59.0

Added

Last updated

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