Update User Status
Activates or deactivates a user. The user is named only by the path. An explicit 0 is accepted, so a deactivated user can be re-activated.
Required permission: user:update
Request
PUT /v2/users/{user_id}/status
Parameters
| Name | Type | In | Description |
|---|---|---|---|
user_id | string | path | Required. User ID (24-character hex) |
Headers
| Name | Description |
|---|---|
Authorization | Required. Bearer <access_token> |
Content-Type | Required. application/json |
Body
| Field | Type | Required | Description |
|---|---|---|---|
status | integer | Yes | 0 = active, 1 = inactive |
Example
curl --request PUT \
--url '{{baseUrl}}/v2/users/6a87455ad5f439809d488ac3/status' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"status": 1
}'
Response
Status Code: 200 OK, empty body.
Errors
| Status | Code | Description |
|---|---|---|
| 400 | 10015 | Validation failed (status missing or not 0/1) — see details |
| 400 | 10016 | user_id is not a valid id |
| 400 | 10001 | User not found (domain 1) |
See Errors for the error format and common codes.