v1

latestOpenAPI 3.0.22026-08-0426137631.3 KB
User APIs

User Bulk Delete API

This API endpoint allows you to delete multiple users by providing their user_ids.

To delete multiple users, make a POST request to the following URL:

POST /v1/users/_delete

The request body should contain a JSON object with an array of user_ids:

{
  "data": {
    "user_ids": [
      "product-1",
      "product-2",
      // ... more product_ids to delete
    ]
  }
}

Response Format

The API will return a JSON object with a message and an array of data containing a task_id that can be used to get the status of the bulk deletion process.

Example Successful 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.

post/v1/users/_delete

Request body

Response

Successful Response

messagestring required

Human-readable message

Example response

{
  "message": "success"
}