Ctrl+K

Remove or set the user to inactive status

delete/api/v2/admin/user/{userId}/remove

Remove or set the user to inactive status.

Path Parameters

  • userIdstringRequired
    Min length: >= 1 characters

200 Response

userRemoved boolean required
Whether the user was successfully removed from the system
removedWallets number required
The number of wallets that were permanently removed
disabledWallets array[string] required
Array of wallet IDs that were disabled (marked as deleted) instead of removed
removedEnterprises array[string] required
Array of enterprise IDs that were removed along with the user
removedOrganizations array[string] required
Array of organization IDs that were removed along with the user

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id