Skip to main content
DELETE
/
api
/
contacts
/
bulk-delete
Bulk delete contacts
curl --request DELETE \
  --url https://your-instance.example.com/api/contacts/bulk-delete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactIds": [
    "64f0a1b2c3d4e5f6a7b8c9d0",
    "64f0a1b2c3d4e5f6a7b8c9d5"
  ]
}
'
{
  "message": "Contacts deleted",
  "deletedCount": 5
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
contactIds
string[]
required

Contact _ids to cascade-delete (along with their conversations, messages, and notifications). Org-scoped unless caller is SUPERADMIN.

Response

Bulk delete completed

​
message
string
​
deletedCount
integer