Post
/api/v1/subscriptions.read
Changelog
| Version | Description |
|---|---|
| 3.11.0 | roomId can be used as argument instead of rid. |
| 0.61.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The token of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The user ID of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Body parameters
RoomId
{
"roomId": "L6su9mxwdDkvdSaT9hvzu8z6mHFigiXy6Y"
}Rid
{
"rid": "L6su9mxwdDkvdSaT9hvzu8z6mHFigiXy6Y"
}AnyOf
object
object
roomId
string Required
The room ID.
ExampleL6su9mxwdDkvdSaT9hvzu8z6mHFigiXy6Y
readThreads
boolean
object
object
rid
string Required
The room ID.
ExampleL6su9mxwdDkvdSaT9hvzu8z6mHFigiXy6Y
readThreads
boolean
Responses
200
OK
Example 1
{
"success": true
}object
success
boolean
400
Bad Request
Invalid Parameter
{
"success": false,
"error": "must have required property 'rid'\n must have required property 'roomId'\n must match a schema in anyOf [invalid-params]",
"errorType": "invalid-params"
}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