Post
/api/v1/chat.unPinMessage
Remove a pinned message from 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 you want to to unpin.
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
Missing Parameter
{
"success": false,
"error": "The required \"messageId\" param is missing. [error-messageid-param-not-provided]",
"errorType": "error-messageid-param-not-provided"
}Invalid Parameter
{
"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