ReferenceDeals
Deals
Public name Deal. Domain entity Opportunity. Same id.
On create, omit stage. The host uses the org default pipeline and the first open stage. If the org has no default pipeline, create fails closed. PATCH stage only to an open stage. Close with POST /deals/{id}/close and reason_id from GET /close-reasons. amount in major units (25000 = 25,000.00).
| HTTP | Path | Scope |
|---|---|---|
| GET | /api/v1/deals | rest.crm.deals.read |
| POST | /api/v1/deals | rest.crm.deals.write |
| GET | /api/v1/deals/{id} | rest.crm.deals.read |
| PATCH | /api/v1/deals/{id} | rest.crm.deals.write |
| GET | /api/v1/close-reasons | rest.crm.deals.read |
| POST | /api/v1/deals/{id}/close | rest.crm.deals.write |
Query
| Parameter | Type | Notes |
|---|---|---|
| limit / cursor | number / string | Cursor page. limit 1–100. |
Fields
| Field | Type | Notes |
|---|---|---|
| id | UUID | Immutable. Same id as Opportunity. |
| title | string | Required. Cannot PATCH to empty. |
| amount | number | null | Major units. 25000 = 25,000.00. Non-negative. Stored as micros. |
| currency | string | null | 3-letter ISO (USD). |
| stage | UUID | Open stage in this org. Omit on create. |
| company_id | UUID | null | Company in this org. |
| primary_contact_id | UUID | null | Contact in this org. |
| owner_id | UUID | null | Same id as GET /members. |
| tag_ids | UUID[] | Full replace. [] clears. |
| pipeline_id | UUID | Write-only on create. Not returned. |