DELETE
/
leads
Delete multiple leads based on a given set of criteria.
curl --request DELETE \
  --url https://api.breakcold.com/leads \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "all_leads": false,
  "leads_ids": [
    "lead1",
    "lead2"
  ],
  "filter": "recent"
}'
{
  "message": "Leads deleted successfully."
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
id_space
string
required

Space identifier required for identifying the deletion context.

Body

application/json

Body containing identifiers for leads to delete or filters defining which leads to delete.

The body is of type object.

Response

200
application/json

Successful deletion of leads.

The response is of type any.