Post
/api/v1/groups.addModerator
Assign the moderator role to a user in a private channel. Learn more about roles from the Roles in Rocket.Chat document.
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": "nSYqWzZ4GsKTX4dyK"
}object
roomId
string Required
The groups's (private channel) ID.
ExampleByehQjC44FwMeiLbX
userId
string Required
The user's ID.
ExamplenSYqWzZ4GsKTX4dyK
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "The required \"roomId\" or \"roomName\" param provided does not match any group [error-room-not-found]",
"errorType": "error-room-not-found"
}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