remove-channel-leader.md

Remove Channel Leader

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

{% hint style="info" %} It requires the set-leader permission. {% endhint %}

HTTP Method	URL	Requires Auth
POST	/api/v1/channels.removeLeader	yes

Body Parameters

Key	Example Value	Description
roomId*	ByehQjC44FwMeiLbX	The channel ID.
userId*	oCHkav5Zf6vmpu2W2	The user ID.

Example Call

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

Example Response

Success

{
    "success": true
}

Error

Any of the following errors can occur:

• Authorization: Requires an authentication token for the request to be made.
• Not Allowed: This occurs when the authenticated user doesn't have the set-leader permission.
• User is not a leader: This occurs when the user is not a leader in the channel.

{% tabs %} {% tab title="Authorization" %}

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

{% endtab %}

{% tab title="Not Allowed" %}

{
    "success": false,
    "error": "Not allowed [error-not-allowed]",
    "errorType": "error-not-allowed",
    "details": {
        "method": "removeRoomLeader"
    }
}

{% endtab %}

{% tab title="User is already a leader" %}

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

{% endtab %} {% endtabs %}

Change Log

Version	Description
0.75.0	Added.