ReferenciaDeals
Deals
Nombre público Deal. Entidad de dominio Opportunity. El mismo id.
En create, omite stage. El host usa el pipeline por defecto de la org y el primer stage abierto. Sin pipeline por defecto, el create falla cerrado. PATCH stage solo a un stage abierto. Cierra con POST /deals/{id}/close y reason_id de GET /close-reasons. amount en unidades mayores (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
| Parámetro | Tipo | Notas |
|---|---|---|
| limit / cursor | number / string | Página de cursor. limit 1–100. |
Campos
| Campo | Tipo | Notas |
|---|---|---|
| id | UUID | Inmutable. El mismo id de Opportunity. |
| title | string | Obligatorio. No puede PATCH vacío. |
| amount | number | null | Unidades mayores. 25000 = 25.000,00. No negativo. Guardado en micros. |
| currency | string | null | ISO de 3 letras (USD). |
| stage | UUID | Stage abierto de esta org. Omite en create. |
| company_id | UUID | null | Empresa de esta org. |
| primary_contact_id | UUID | null | Contacto de esta org. |
| owner_id | UUID | null | El mismo id de GET /members. |
| tag_ids | UUID[] | Replace total. [] limpia. |
| pipeline_id | UUID | Write-only en create. No vuelve en la respuesta. |