Delete User

DELETE

/v2/api/user/{user_id}

Overview

The Delete User endpoint allows the removal of a user from the system using their unique user_id.
The deletion is permanent and should be performed with caution.

Functionality

Accepts a valid user_id as a path parameter to identify the user to be deleted.

Requires appropriate authorization to ensure only privileged users (e.g., administrators) can execute this operation.

Returns a confirmation message upon successful deletion.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request DELETE 'https:///v2/api/user/191' \
--header 'Ocp-Apim-Subscription-Key;'

Response Example

{
    "success": true,
    "message": "User deleted successfully.",
    "data": {}
}

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Successfully deleted the user.

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Edit User

Batch Delete Users

Delete User

Overview#

Functionality#

Request

Responses

Overview

Functionality