Favicon

You are here: Home > API Reference > Workspace > Users > Delete user account permanently

Delete user account permanently

Permanently deletes a user account and removes their access to the platform, this operation cannot be undone and should be used carefully as it affects user authentication and organizational membership.

DELETE
/v1/users/:userId
Copy to clipboard

Delete user account permanently

Permanently deletes a user account and removes their access to the platform, this operation cannot be undone and should be used carefully as it affects user authentication and organizational membership.

Request

Add parameter in header authorization
Example: Authorization: Bearer <token>
userId string
required
Unique identifier of the user account to retrieve, used to fetch complete profile information including personal details, organization memberships, roles, and activity tracking data.
Match pattern: ^[a-fA-F0-9]{24}$

Responses

200 Response application/json
status boolean optional
data object optional
delete string optional
OK
{
    "status": true,
    "data": {
        "delete": "OK"
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4001
message string optional
Unauthorized
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}