This page documents the canonical HTTP contract. Switch to the CLI example when you want the operator workflow.
Delete sets record_status=archived and returns HTTP 204 with no body. The CLI prints a local archive confirmation after that successful response. The Deal, Notes links, activity, and lifecycle history remain stored. Default Deal lists exclude archived records; use include_archived=true or GET by exact ID to inspect them.
Path parameters
deal_idrequiredstring
Exact Deal ID.
| Name | Type | Description |
|---|---|---|
| deal_idrequired | string | Exact Deal ID. |
Errors
| Status | Meaning |
|---|---|
| 401 | Authentication required. |
| 403 | Missing deals:write scope. |
| 404 | Deal not found in this organization. |
