Skip to main content
POST
/
api
/
v1
/
users
/
bulk-delete
/
jobs
Create Bulk User Delete Job
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}'
{
  "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

Bulk delete job created successfully (Accepted)

​
id
string

Unique identifier for the bulk delete job

Example:

"507f1f77bcf86cd799439011"