Update user(s) status

NOTE : This API endpoint is supported in version 5.0 onwards.

Overview

This API call is used to update the status of the users given in the request body. The three status types are allowed - Active,Inactive and Anonymise.

HTTP Request

PUT   /api/4/users?status=inactive/active/anonymise

HTTP Request Object

Request xml

<users> 
    <user> 
        <userid>102</userid>
        <userid>101</userid>
    </user>
</users>

Request JSON

{
    "user": {
        "userid": [
            "102",
            "101"
        ]
    }
}

HTTP Headers

HTTP Response

Success

HTTP response 200 

Example HTTP Request & Response

PUT http://example.com/context/api/4/users?status=inactive

Error messages