Delete record
delete_recordArchive (soft-delete) a record by object_type + id. DESTRUCTIVE — call once to get a confirmation prompt, then again with confirm:true. Sets deleted_at (never a hard delete) for custom objects, saved reports (creator, manager, or admin), a whole quote (its line items cascade), AND contact plus the core leaf objects opportunity / task / signal / touch — so a mistaken or duplicate one can be removed. Contact history and account links are retained for restore. An ACCOUNT can be removed too (e.g. a junk import), but ONLY once it has no live records under it — an account with any open opportunity or any subscription is refused with the counts and the next step (close / re-point / mark-lost those first); its contacts, touches, notes, and tasks are kept as history and don't block. Subscription still doesn't remove this way (it has cancel_subscription) — change it via update_record. A single quote line item can't be deleted directly (change the line set with update_quote). Returns the archived record.
When to use: Archive a record (soft delete; pass confirm:true) — a custom-object record, a saved report, a contact, or a core leaf object (opportunity / task / signal / touch), e.g. a mistaken or duplicate record. Contact history and account links are retained for web restore. An account is removable too once nothing live sits under it (open deals / subscriptions refuse with the counts); subscription doesn't remove this way — cancel or change it via update_record.
Example: Delete that duplicate contact .
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | A uuid. | |
| confirm | No | Boolean (true/false). | |
| object_type | Yes | Object key of the record to archive, e.g. contact, opportunity, task, touch, account, report, quote, a custom object's key, or rollup / automation (admin-only); subscription is refused. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | ||
| record | No | ||
| result | No | ||
| deleted | No | ||
| requires_confirm | No |