Remove Group Moderator

Prev Next
Post
/api/v1/groups.removeModerator

Remove the moderator role from a user in a private 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
Success
{
  "roomId": "ByehQjC44FwMeiLbX",
  "userId": "oCHkav5Zf6vmpu2W2"
}
object
roomId
string Required

The private group ID. You can find the IDs by using any of the following endpoints:

  • Get List of User Groups: This endpoint returns all private channels in the workspace, if you have the required permissions to view them.
  • Get Groups: This endpoint returns the private channels that you are a member of.
ExampleByehQjC44FwMeiLbX
userId
string Required

The ID of the user to be removed from moderator role. Alternatively, you can use the userName parameter and enter the username, instead of the ID.

ExampleoCHkav5Zf6vmpu2W2
Responses
200

OK

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

Bad Request

Example 1
{
  "success": false,
  "error": "The parameter \"roomId\" or \"roomName\" is required [error-room-param-not-provided]",
  "errorType": "error-room-param-not-provided"
}
Example 2
{
  "success": false,
  "error": "The required \"userId\" or \"username\" param was not provided [error-user-param-not-provided]",
  "errorType": "error-user-param-not-provided"
}
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