User Delete API

This API endpoint allows you to delete a specific user from the system using their user_id.

Notice: Make sure the user_id is an urlencode string.

To remove a user, make a DELETE request to:

DELETE /v1/users/{user_id}

Replace {user_id} with the unique identifier of the user you wish to delete.

Response Format

The API will return a JSON object with a task_id that can be used to retrieve.

Example Error Response

{
  "message": "deleted",
  "data": {
    "task_id": "{task_id}"
  }
}

To check the exact response body of this task_id, make a GET request to the following endpoint:

GET /v1/users/_status/{task_id}

Replace {task_id} with the task_id returned from the response.

{
  "message": "success"
}