Batch Delete Users

DELETE

/v2/api/user/batch

Overview

The Batch Delete Users endpoint enables the deletion of multiple users in a single operation by submitting their user IDs in the request body.
This endpoint is especially useful for bulk administrative actions, such as cleaning up inactive users or managing user access during organization changes.

Functionality

Accepts an array of valid user_ids in the request body to identify which users should be deleted.

Requires authorization through a subscription key to ensure only privileged users can execute the deletion.

On success, returns a list of deleted user details including their personal and organization information.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request DELETE 'https:///v2/api/user/batch' \
--header 'Ocp-Apim-Subscription-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user_ids": [
        192,
        77
    ]
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "Users deleted successfully.",
    "data": [
        {
            "id": 4,
            "email": "user@example.com",
            "is_staff": false,
            "is_superuser": false,
            "is_active": false,
            "date_joined": "2024-01-22T12:33:50.918362Z",
            "first_name": "user",
            "last_name": "user",
            "organization": {
                "id": 1,
                "org_name": "Data Science Dojo",
                "domain": "datasciencedojo.com",
                "org_logo_url": "string",
                "org_icon_url": "string",
                "is_deleted": false,
                "created_by": "System",
                "created_on": "2024-01-20T01:32:56.659642Z",
                "modified_by": "user@example.com",
                "modified_on": "2024-01-20T01:32:56.659663Z"
            }
        }
    ]
}

Request

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Users successfully deleted.

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Delete User

User Filtered

Batch Delete Users

Overview#

Functionality#

Request

Responses

Overview

Functionality