Remove Channel Moderator

Prev Next
Post
/api/v1/channels.removeModerator

Remove the moderator role from a user in a channel.

Permission required: set-moderator.

Changelog

Version Description
0.49.4 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
{
  "roomId": "ByehQjC44FwMeiLbX",
  "userId": "oCHkav5Zf6vmpu2W2"
}
object
roomId
string Required

The channel's id

userId
string Required

The user's id

Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
400

Bad Request

User is not a moderator
{
  "success": false,
  "error": "User is not a moderator [error-user-not-moderator]",
  "errorType": "error-user-not-moderator",
  "details": {
    "method": "removeRoomModerator"
  }
}
Expand All
object
success
boolean
error
string
errorType
string
details
object
method
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string