set-users-status-active.md

Set User's Status Active

HTTP Method	URL	Requires Auth
POST	/api/v1/users.setActiveStatus	yes

{% hint style="info" %} Permissions required:

• edit-other-user-active-status
• manage-moderation-actions {% endhint %}

Body Parameters

Key	Example Value	Description
activeStatus*	true	The value of the active status.
userId*	5HmCfpoB7jp2uibTC	The user ID whose status value is to be changed.
confirmRelinquish	true	Allows the user to be deactivated even if it is the last owner of a room. By default, the value is false.

{% hint style="info" %} If activeStatus=false & confirmRelinquish=true and the user is the last remaining owner of a room, the oldest member of that room will be chosen as the new owner. {% endhint %}

Example call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type:application/json" \
     http://localhost:3000/api/v1/users.setActiveStatus \
     -d '{
          "activeStatus": false, 
          "userId": "5HmCfpoB7jp2uibTC"}'

Example Response

{
    "user": {
        "_id": "jJNyu4BQFqdgEcqnR",
        "active": false
    },
    "success": true
}

Change Log

Version	Description
3.7.0	Added confirmRelinquish to the payload.
0.75.0	Added.