Deactivate User
Deactivate a platform user account.
POST
/api/v1/users/{id}/deactivateDescription
Sets is_blocked on a registered user. The default company user cannot be deactivated.
Request
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer <access_token> | Yes |
| Content-Type | application/json | Yes |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | number | Yes | Registered platform user ID (not invite_id). |
Response
Related Endpoints
Did this page help you?
Request
curl -X POST https://uat.unduit.com/api-exposed/api/v1/users/42/deactivate \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"Success Response
{
"message": "User deactivated successfully.",
"status": 0,
"is_blocked": 1,
"account_status": "Inactive",
"user": {
"id": 42,
"email": "user@example.com",
"name": "Jane Smith",
"country": "US",
"role": 3,
"role_name": "Requester",
"account_status": "Inactive",
"is_blocked": 1,
"is_default_user": false,
"status": 0
}
}