Follow Message
- Print
- DarkLight
- PDF
Follow Message
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/chat.followMessage
Follow a message to receive notifications.
Changelog
Version | Description |
---|---|
1.0.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 1
{
"mid": "7aDSXtjMA3KPLxLjt"
}
object
mid
string Required
The message ID to follow.
Responses
200
OK
Success
{
"success": true
}
object
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "[The required \"mid\" body param is missing.]",
"errorType": "The required \"mid\" body param is missing."
}
Invalid message ID
{
"success": false,
"error": "Invalid message [error-invalid-message]",
"errorType": "error-invalid-message",
"details": {
"method": "followMessage"
}
}
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
Was this article helpful?