Skip to main content
DELETE
/
api
/
public
/
v1
/
campaigns
/
{campaign_id}
/
leads
Delete leads
curl --request DELETE \
  --url https://api.coldsend.pro/api/public/v1/campaigns/{campaign_id}/leads \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
[
  "3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
'
{
  "success": true,
  "message": "<string>",
  "deleted_count": 123,
  "failed_count": 123,
  "errors": [
    {}
  ]
}

Authorizations

X-API-Key
string
header
required

API key with format cs_live_xxx

Path Parameters

campaign_id
string<uuid>
required

Query Parameters

Body

application/json

Response

Leads deleted successfully

Response for lead deletion.

success
boolean
required
message
string
required
deleted_count
integer
required

Number of leads deleted

failed_count
integer
required

Number of deletions that failed

errors
Errors · object[]

Errors for failed deletions