Create Bulk User Delete Job

Create a bulk delete job to delete multiple users. This endpoint accepts a CSV file containing user IDs and creates deletion jobs for processing. Requires admin permissions.

POST /api/v1/users/bulk-delete/jobs

Create Bulk User Delete Job

cURL

curl --request POST \
  --url https://apix.us.amity.co/api/v1/users/bulk-delete/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form 'deleteOptions={"deleteAll":true,"markMessageDeleted":false,"hardDeletePost":false,"hardDeleteComment":false}'

202

{
  "id": "507f1f77bcf86cd799439011"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data

file · file · required

CSV file containing user IDs to delete

deleteOptions · string

JSON string containing delete options

Example:

"{\"deleteAll\":true,\"markMessageDeleted\":false,\"hardDeletePost\":false,\"hardDeleteComment\":false}"

Response

202

application/json

Bulk delete job created successfully (Accepted)

id · string

Unique identifier for the bulk delete job

Example:

"507f1f77bcf86cd799439011"