Remove Group Leader

Prev Next
Post
/api/v1/groups.removeLeader

Remove the leader role from a user in a private channel.

Permission required: set-leader

Changelog

Version Description
0.58.0 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 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.
userId
string Required

The user ID.

Responses
200

OK

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

Bad Request

User is not a leader
{
  "success": false,
  "error": "User is not a leader [error-user-not-leader]",
  "errorType": "error-user-not-leader"
}
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