crm_delete_deal
Archive a HubSpot deal to remove it from the pipeline board when the record should not exist. Use only for erroneous deals; for lost deals, move to a closed-lost stage instead.
Instructions
Archive (soft-delete) a HubSpot deal so it drops off the pipeline board.
Prefer moving a lost deal to a closed-lost stage with crm_update_deal, which keeps it in reporting. Archive only when the record should not have existed.
Writes, and destructive from an agent's point of view. Needs the crm.objects.deals.write scope. Archiving the same id again leaves it archived. The record is dropped from the read cache and stops appearing in searches. Raises a not-found error for an id that never existed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| deal_id | Yes | HubSpot deal record id, as returned by search or create. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Id of the record that was archived. | |
| archived | Yes | Always true. The record was archived, not permanently deleted. |