Update a deal

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Path Parameters

id*string

Deal UUID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

pipelineId?string

UUID of the pipeline this deal belongs to

stageId?string

UUID of the pipeline stage

title?string

Deal title

Lengthlength <= 255

clientId?string

UUID of the associated client

assignedToUserId?string

UUID of the assigned user

description?string

Detailed description or notes

value?number

Expected deal value (before VAT)

Range0 <= value

probability?number

Win probability override (0-100)

Range0 <= value <= 100

currency?string

Currency code (ISO 4217)

expectedCloseDate?string

Expected close date (YYYY-MM-DD)

source?string

Lead source (e.g. whatsapp, form, manual, website, campaign)

Lengthlength <= 50

lineItems?array<>

Line items (REPLACE-SET semantics: sending this array replaces ALL existing line items for the deal — omit the field to leave line items untouched, send [] to clear them). Server recomputes lineSubTotal/lineVatTotal/lineGrandTotal via Decimal.js and, when the resulting set is non-empty, recomputes deal.value as the sum of lineGrandTotal.

Response Body

`application/json`

curl -X PATCH "https://example.com/crm/deals/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "businessId": "string",  "pipelineId": "string",  "pipelineName": "string",  "stageId": "string",  "stageName": "string",  "title": "string",  "clientId": "string",  "clientName": "string",  "client": {    "id": "string",    "name": "string",    "phone": "string",    "email": "string"  },  "assignedToUserId": "string",  "assignedToUserName": "string",  "description": "string",  "status": "open",  "value": 0,  "probability": 0,  "currency": "string",  "expectedCloseDate": "string",  "source": "string",  "lostReason": "string",  "closedAt": "2019-08-24T14:15:22Z",  "lineItems": [    {      "id": "string",      "dealId": "string",      "productId": "string",      "description": "string",      "quantity": 0,      "unitPrice": 0,      "discountType": "PERCENT",      "discountValue": 0,      "vatRate": 0,      "itemVatMode": "exempt",      "lineSubTotal": 0,      "lineVatTotal": 0,      "lineGrandTotal": 0,      "sortOrder": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "primaryQuoteStatus": "created",  "primaryQuoteViewCount": 0,  "primaryQuoteDocNumber": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Authorization

Path Parameters

Request Body

Response Body

200application/json

404

`application/json`