Delete lead
Soft deletes an active lead.
Bearer API key · Scope: leads.write
Endpoint
Path parameters1 parameter
lead_idrequiredstring—
Headers1 parameter
Idempotency-Keyrequiredstring—
Responses
200Lead soft deleted.
Headers
Idempotency-ReplayedPresent and true when a stored successful write response was replayed.
application/json
object
| Name | Type | Description |
|---|---|---|
deletedrequired | const: true | — |
lead_idrequired | string | — |
400Request payload, query, or required header is invalid.
application/json
ErrorResponse401Missing, malformed, revoked, deleted, or unknown API key.
Headers
WWW-AuthenticateDocumented response header
application/json
ErrorResponse403API key lacks the required scope or the workspace is not active.
application/json
ErrorResponse404Resource not found in the key-bound workspace.
application/json
ErrorResponse409Request conflicts with idempotency or external event identity.
application/json
ErrorResponse429Rate limit exceeded for this key and endpoint or invalid-auth bucket.
Headers
X-RateLimit-LimitMaximum requests allowed in the current window.X-RateLimit-RemainingRequests remaining in the current window.X-RateLimit-ResetISO timestamp when the current rate-limit window resets.Retry-AfterSeconds until the caller should retry.
application/json
ErrorResponse500Internal authentication or server error.
application/json
ErrorResponse