Rocket.Chat
Mobile App
Desktop App
Omnichannel
Apps Engine
Fuselage
Pins Message
Pins a chat message to the message's channel.
URL
Requires Auth
HTTP Method
/api/v1/chat.pinMessageyesPOSTPayload
Argument
Example
Required
Description
messageId7aDSXtjMA3KPLxLjtRequired
The message id to pin.
Example Call
1
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
2
-H "X-User-Id: Z3cpiYN6CNK2oXWKv" \
3
-H "Content-type:application/json" \
4
http://localhost:3000/api/v1/chat.pinMessage \
5
-d '{ "messageId": "7aDSXtjMA3KPLxLjt" }'
Copied!
Example Result
1
{
2
"message": {
3
"t": "message_pinned",
4
"rid": "GENERAL",
5
"ts": "2017-09-27T20:39:57.921Z",
6
"msg": "",
7
"u": {
8
"_id": "Z3cpiYN6CNK2oXWKv",
9
"username": "graywolf336"
10
},
11
"groupable": false,
12
"attachments": [
13
{
14
"text": "Hello",
15
"author_name": "graywolf336",
16
"author_icon": "/avatar/graywolf336?_dc=0",
17
"ts": "2017-09-27T19:36:01.683Z"
18
}
19
],
20
"_updatedAt": "2017-09-27T20:39:57.921Z",
21
"_id": "hmzxXKSWmMkoQyiAd"
22
},
23
"success": true
24
}
Copied!
Change Log
Version
Description
0.59.0
Added
Last modified 1yr ago
Export as PDF
Copy link
Edit on GitHub