Ignore User
- Print
- DarkLight
- PDF
Ignore User
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/chat.ignoreUser
Ignore or unignore a user in chat.
Changelog
| Version | Description |
|---|---|
| 0.64.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
Query parameters
rid
stringRequired
The room ID.
userId
stringRequired
The user ID.
ignore
boolean
If the user is to be ignored or not, default is true.
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "The required \"rid\" param is missing. [error-room-id-param-not-provided]",
"errorType": "error-room-id-param-not-provided"
}Example 2
{
"success": false,
"error": "The required \"userId\" param is missing. [error-user-id-param-not-provided]",
"errorType": "error-user-id-param-not-provided"
}Invalid room or user ID
{
"success": false,
"error": "Invalid subscription [error-invalid-subscription]",
"errorType": "error-invalid-subscription",
"details": {
"method": "ignoreUser"
}
}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?