Skip to main content
DELETE
/
api
/
leads
/
sync
Bulk delete leads
curl --request DELETE \
  --url https://api.naturalead.ai/api/leads/sync \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "lead_ids": [
    "<string>"
  ]
}
'
{
  "total": 123,
  "deleted": 123,
  "notFound": 123
}

Authorizations

​
X-API-Key
string
header
required

API key passed via the X-API-Key header.

Body

application/json
​
lead_ids
string[]
required

Array of external lead IDs to delete.

Response

Delete operation completed successfully.

​
total
integer

Total number of IDs processed.

​
deleted
integer

Number of leads successfully deleted.

​
notFound
integer

Number of IDs that did not match any existing lead.