Pin Message

Prev Next
Post
/api/v1/chat.pinMessage

Pin a chat message to the channel.

Changelog

Version Description
0.59.0 Added
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example
{
  "messageId": "7aDSXtjMA3KPLxLjt"
}
object
messageId
string Required

The message ID that you want to pin.

Responses
200

OK

Example 1
{
  "message": {
    "_id": "651f23c0a2f73c7460e18d1a",
    "t": "message_pinned",
    "rid": "6GFJ3tbmHiyHbahmC",
    "ts": "2023-10-05T20:59:44.503Z",
    "msg": "",
    "u": {
      "_id": "5fRTXMt7DMJbpPJfh",
      "username": "test.test",
      "name": "Testtest"
    },
    "groupable": false,
    "attachments": [
      {
        "text": "hola",
        "author_name": "roxie",
        "author_icon": "/avatar/roxie",
        "ts": "2023-10-05T20:30:51.052Z",
        "attachments": []
      }
    ],
    "_updatedAt": "2023-10-05T20:59:44.521Z"
  },
  "success": true
}
Expand All
object
message
object
_id
string
t
string
rid
string
ts
string
msg
string
u
object
_id
string
username
string
name
string
groupable
boolean
attachments
Array of object
object
text
string
author_name
string
author_icon
string
ts
string
attachments
Array of object
object
_updatedAt
string
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "The required \"messageId\" param is missing. [error-messageid-param-not-provided]",
  "errorType": "error-messageid-param-not-provided"
}
Example 2
{
  "success": false,
  "error": "The provided \"messageId\" does not match any existing message. [error-message-not-found]",
  "errorType": "error-message-not-found"
}
object
success
boolean
error
string
errorType
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string