set-channel-moderator.md

Set Channel Moderator

Gives the role of moderator to a user in the current channel.

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

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

Body Parameters

Key	Example Value	Description
roomId*	ByehQjC44FwMeiLbX	The channel ID for which you want to set the moderator.
userId*	nSYqWzZ4GsKTX4dyK	The user ID that you want to set as the moderator.

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.addModerator \
     -d '{ 
          "roomId": "ByehQjC44FwMeiLbX", 
          "userId": "nSYqWzZ4GsKTX4dyK" }'

Example Response

Success

{
    "success": true
}

Error

Any of the following errors can occur on the endpoint.

• Authorization: Requires an authentication token for the request to be made.
• Not Allowed: This occurs when the authenticated user doesn't have the set-moderator permission.
• User is already a moderator: This occurs when the user is already a moderator 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": "addRoomModerator"
    }
}

{% endtab %}

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

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

{% endtab %} {% endtabs %}

Change Log

Version	Description
0.49.4	Added