Rocket.Chat
Mobile App
Desktop App
Omnichannel
Apps Engine
Fuselage
Ignore User
Ignores an user in a chat. If you pass ignore as false, the user will be unignored.
URL
Requires Auth
HTTP Method
/api/v1/chat.ignoreUseryesGETPayload
Argument
Example
Required
Description
ridKLTM332QEwWLPJrjRPtcPHimPnLHsusiDFRequired
The room ID.
userId7aDSXtjMA3KPLxLjtRequired
The User ID.
ignoretrueOptional
If the user will be ignored or not, default is true.
Example Call
1
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
2
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
3
-H "Content-type:application/json" \
4
http://localhost:3000/api/v1/chat.ignoreUser?rid=KLTM332QEwWLPJrjRPtcPHimPnLHsusiDF&userId=7aDSXtjMA3KPLxLjt
Copied!
1
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
2
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
3
-H "Content-type:application/json" \
4
http://localhost:3000/api/v1/chat.ignoreUser?rid=KLTM332QEwWLPJrjRPtcPHimPnLHsusiDF&ignore=true
Copied!
1
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
2
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
3
-H "Content-type:application/json" \
4
http://localhost:3000/api/v1/chat.ignoreUser?rid=KLTM332QEwWLPJrjRPtcPHimPnLHsusiDF&ignore=false
Copied!
Example Result
1
{
2
"success": true
3
}
Copied!
Change Log
Version
Description
0.64.0
Added
Last modified 1yr ago
Export as PDF
Copy link
Edit on GitHub