Skip to main content
DELETE
DeleteLeadAPI removes one lead from Erdo: its row and identity, its

Authorizations

Authorization
string
header
required

An Erdo API key (erdo_api_...) or scoped token (erdo_token_...).

Path Parameters

datasetSlug
string
required
leadRef
string
required

Query Parameters

deleted_by_external_ref
string

DeletedByExternalRef is the calling product's own handle for the person who deleted the lead. Opaque and unverified.

check_only
boolean

CheckOnly asks whether the delete would go ahead and removes nothing: the answer is state "deletable", or the refusal the delete would give.

Response

Success response

dataset_id
string
deleted_at
string<date-time>
lead_id
string

more.

reference
string
removed
Removed counts the records each store gave up, by kind. · object
shared_emails
integer<int64>
shared_phones
integer<int64>

lead in the organization still holds. What is kept by number or address for those — a text thread stamped with the other lead, consent, unlinked calls — was left in place.

state
string

for a call naming a lead an earlier delete removed, and "deletable" for a check that found nothing in the way.