Skip to main content
POST
Permanently Delete Leads in Bulk
Safety and behavior notes
  • A forensic snapshot is written to lead_hard_delete_audit in the same transaction before each deletion.
  • Active cadence-job cancellation is best-effort after the committed deletion; cancellation failure does not restore data.
  • Each lead commits independently, with no transaction or rollback for the complete batch.
  • This is irreversible and permanently deletes every matched lead plus cascaded conversations, messages, meetings, calls, field values, notes, and tasks.
  • An MCP preview does not call this REST operation and is not part of the REST contract.
  • Direct REST requires confirm=true. Omitting confirm or sending false returns HTTP 400 and does not provide a preview.

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Body

application/json
lead_ids
any[]
required
Required array length: 1 - 500 elements

String UUIDs are processed; malformed/non-string entries are returned in failed[]. Duplicates are silently de-duplicated after total is captured.

confirm
enum<boolean>
required
Available options:
true

Response

Permanent-delete batch outcome; partial/per-row failures remain HTTP 200.

success
boolean
required
total
integer
required
Required range: 1 <= x <= 500
hard_deleted
integer
required
Required range: x >= 0
failed
object[]
required
Last modified on September 8, 2026