This API endpoint is designed for developers to delete a user from the system. Below are the details about the endpoint:
- Method: DELETE
- Path:
/en/developer/api/user/delete
- Description: This endpoint is used to remove a user from the database. It requires proper authentication and authorization to ensure the security of the user data.
Usage
To delete a user, you need to send a DELETE request to the above endpoint. The request must include the user ID or any other unique identifier required to locate the user in the database.
Example Request
DELETE /en/developer/api/user/delete?userId=12345
Authorization: Bearer <access_token>
Security
- Authentication: Ensure that the request is authenticated with a valid access token.
- Authorization: The user making the request must have the necessary permissions to delete users.
Response
The response will be in JSON format and will contain the status of the operation:
{
"status": "success",
"message": "User deleted successfully."
}
Or, if the operation fails:
{
"status": "error",
"message": "User not found."
}
Related Links
User_Delete_API