Ejento APIs

Batch Delete Users

DELETE

/api/user/batch

User APIs

Deletes a list of users specified by their user IDs.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE '/api/user/batch' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user_ids": [
        7
    ]
}'

Response Example

{
    "success": true,
    "message": "Users deleted successfully.",
    "data": [
        {
            "id": 4,
            "email": "john@example.com",
            "is_staff": false,
            "is_superuser": false,
            "is_active": true,
            "date_joined": "2024-10-02T00:02:24.378434Z",
            "first_name": "John",
            "last_name": "Doe",
            "organization": {
                "id": 1,
                "org_name": "Tech Solutions",
                "domain": "techsolutions.com",
                "is_deleted": false,
                "created_by": "System",
                "created_on": "2024-09-27T22:40:45.279198Z",
                "modified_by": "",
                "modified_on": "2024-09-27T22:40:45.279237Z"
            }
        },
        {
            "id": 2,
            "email": "",
            "is_staff": false,
            "is_superuser": false,
            "is_active": true,
            "date_joined": "2024-09-27T22:41:10.250883Z",
            "first_name": null,
            "last_name": null,
            "organization": {
                "id": 1,
                "org_name": "Tech Solutions",
                "domain": "techsolutions.com",
                "is_deleted": false,
                "created_by": "System",
                "created_on": "2024-09-27T22:40:45.279198Z",
                "modified_by": "",
                "modified_on": "2024-09-27T22:40:45.279237Z"
            }
        },
        {
            "id": 3,
            "email": "admin@example.com",
            "is_staff": true,
            "is_superuser": true,
            "is_active": true,
            "date_joined": "2024-09-27T22:41:22.274470Z",
            "first_name": "Admin",
            "last_name": "User",
            "organization": {
                "id": 1,
                "org_name": "Tech Solutions",
                "domain": "techsolutions.com",
                "is_deleted": false,
                "created_by": "System",
                "created_on": "2024-09-27T22:40:45.279198Z",
                "modified_by": "",
                "modified_on": "2024-09-27T22:40:45.279237Z"
            }
        }
    ]
}

Request

Body Params application/json

user_ids

array[integer]

optional

List of user IDs to be deleted.

Examples

Responses

🟢200OK

application/json

Users successfully deleted.

Body

success

boolean

optional

Indicates if the operation was successful.

message

string

optional

Message indicating the result of the operation.

data

array [object {9}]

optional

integer

optional

ID of the deleted user.

string

optional

Email of the user.

is_staff

boolean

optional

Indicates if the user is a staff member.

is_superuser

boolean

optional

Indicates if the user is a superuser.

is_active

boolean

optional

Whether the user was active at the time of deletion.

date_joined

string <date-time>

optional

The date the user joined.

first_name

string | null

optional

First name of the user.

last_name

string | null

optional

Last name of the user.

organization

object

optional

Delete User Permission by ID

Get Tokens by Date