Leads

Delete lead

Soft-deletes the lead, stops its enrollments, cancels queued campaign message jobs, and emits lead.deleted.

DELETE/v1/campaigns/{id}/leads/{leadId}

Authorization

bearerAuth

AuthorizationBearer <token>

Use an account API key in the Authorization header: Authorization: Bearer f_....

In: header

idstring

Campaign id.

Formatuuid

leadIdstring

Lead id.

Formatuuid

curl -X DELETE "https://example.com/v1/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08/leads/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "data": {    "id": "9c3cb55a-5e5e-47b6-a95e-31461779ce92",    "deleted": true  }}

{  "error": {    "type": "authentication_error",    "code": "invalid_api_key",    "message": "A valid Furnace API key is required"  }}

{  "error": {    "type": "permission_error",    "code": "smartlead_read_only",    "message": "Smartlead campaigns are read-only via the API"  }}

{  "error": {    "type": "invalid_request_error",    "code": "campaign_not_found",    "message": "Campaign not found"  }}

{  "error": {    "type": "rate_limit_error",    "code": "rate_limit_exceeded",    "message": "Rate limit exceeded for this account"  }}

{  "error": {    "type": "api_error",    "code": "internal_error",    "message": "Internal server error"  }}