ReferênciaDeals
Deals
Nome público Deal. Entidade de domínio Opportunity. O mesmo id.
No create, omita stage. O host usa o pipeline padrão da org e o primeiro stage aberto. Sem pipeline padrão, o create falha fechado. PATCH stage só para stage aberto. Feche com POST /deals/{id}/close e reason_id de GET /close-reasons. amount em unidades maiores (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 | Imutável. Mesmo id da Opportunity. |
| title | string | Obrigatório. Não pode PATCH vazio. |
| amount | number | null | Unidades maiores. 25000 = 25.000,00. Não negativo. Gravado em micros. |
| currency | string | null | ISO de 3 letras (USD). |
| stage | UUID | Stage aberto desta org. Omita no create. |
| company_id | UUID | null | Empresa desta org. |
| primary_contact_id | UUID | null | Contato desta org. |
| owner_id | UUID | null | Mesmo id de GET /members. |
| tag_ids | UUID[] | Replace total. [] limpa. |
| pipeline_id | UUID | Write-only no create. Não volta na resposta. |