Links
Comment on page

Channel Remove Moderator

Removes the role of moderator from a user in the current channel.
It requires the set-moderatorpermission.
URL
Requires Auth
HTTP Method
/api/v1/channels.removeModerator
yes
POST

Payload

Argument
Example
Required
Description
roomId
ByehQjC44FwMeiLbX
Required
The channel's id
userId
nSYqWzZ4GsKTX4dyK
Required
The user's id

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
-H "Content-type: application/json" \
https://localhost:3000/api/v1/channels.removeModerator \
-d '{ "roomId": "ByehQjC44FwMeiLbX", "userId": "nSYqWzZ4GsKTX4dyK" }'

Example Result

Success

{
"success": true
}

Error

Any of the following errors can occur on the endpoint.
  • Authorization: Requires an authentication token for the request to be made.
  • Not Allowed: This occurs when the authenticated user doesn't have the set-moderator permission.
  • User is not a moderator: This occurs when the user is not a moderator in the channel.
Authorization
Not Allowed
User is not a moderator
{
"status": "error",
"message": "You must be logged in to do this."
}
{
"success": false,
"error": "Not allowed [error-not-allowed]",
"errorType": "error-not-allowed",
"details": {
"method": "removeRoomModerator"
}
}
{
"success": false,
"error": "User is not a moderator [error-user-not-moderator]",
"errorType": "error-user-not-moderator",
"details": {
"method": "removeRoomModerator"
}
}

Change Log

Version
Description
0.49.4
Added
Last modified 2mo ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.