Activate or deactivate user account

PATCH

/admin/users/{id}/status

Last modified:2026-11-03 23:10:15

Ban (deactivate) or unban (activate) user account. Immediately revokes sessions. Admins cannot deactivate themselves or the last remaining admin.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

User status successfully updated

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/admin/users//status' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "banned": true,
    "banReason": "string"
}'

Response Example

200 - Example 1

{
    "id": "string",
    "name": "string",
    "email": "user@example.com",
    "emailVerified": true,
    "role": "string",
    "banned": true,
    "banReason": [
        "string"
    ],
    "image": [
        "string"
    ],
    "createdAt": "string",
    "updatedAt": "string"
}

Modified at 2026-11-03 23:10:15

List and search users

List user shipping addresses