Deactivate User

You can use this API request to deactivate and suspend a user for users who are not abiding by the community rules.

/services/v2/user/[userId]/deactivateUser.json

You can use the following parameters in your deactivate user request:

Specific options: reason

🚧

Permissions & Notes:

  • You must have the Edit users and groups permission under Site Administration Roles in the Advanced Editor.

  • We added this request in version 1.6.3.

Sample Request

A PUT deactivate user request to deactivate a user (userId: 97) sent to https://apidocs.cloud.answerhub.com using a human-readable Username/Password (answerhub:test123) would look like this:

curl 
-u "answerhub:test123" 
-H "Accept: application/json" 
-H "Content-type: application/json" 
-X PUT "https://apidocs.cloud.answerhub.com/services/v2/user/97/deactivateUser.json" -v

In the example above, we deactivated (similar to suspension) demo3 (user 97) and they cannot access the community. The difference between suspension and deactivation is that the user is usually deactivated because of more destructive behavior or they have left the company. The deactivated user also does not get included in the user count, thus freeing up license capacity.

Expected Response

Successful Response:

  • HTTP Status 200 - OK
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!