Deactivate a User
Deactivates a user in your account.
Note: It is mandatory to pass the UserId in the query string. You can retrieve it using the Get Users API.
Also see, Activate a User.
API URL
URL
GET
https://{host}/v2/UserManagement.svc/User/Deactivate?accessKey=AccessKey&secretKey=SecretKey&userId=UserId
URL Parameters
| Parameter | Description |
|---|---|
| UserId | Unique identifier of the user. |
Response
200 OK
Content-Type: application/json
{
"Status": "Success"
}
HTTP Response Codes
| Code | Description |
|---|---|
| 200 OK | This is the status code for successful API call. |
| 401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
| 400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
| 404 Not Found | The API could not be found. Please check the API signature. |
| 429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
| 500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |
