Rocket.Chat SaaS

Channel Remove Leader

Removes the role of Leader for a user in the current channel.

URL

Requires Auth

HTTP Method

/api/v1/channels.removeLeader

yes

POST

Payload

Argument

Example

Required

Description

roomId

ByehQjC44FwMeiLbX

Required

The channel's id

userId

oCHkav5Zf6vmpu2W2

Required

The user's id

Example Call

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

Success Example Result

{
"success": true
}

Bad Request Example Result

If the user is not a leader, will return a 400 bad request status.

{
"success": false,
"error": "User is not a leader [error-user-not-leader]",
"errorType": "error-user-not-leader"
}

Change Log

Version

Description

0.75.0

Added.