Update a deal
Partially updates a deal. Use it to move a deal to another stage, mark it won or lost, or change its data.
Endpoint
PATCH/deals/:id
Body
Any writable field of the deal object. Fields not in the object are rejected.
status: "won"setswon_date;status: "lost"setslost_date;status: "open"clears both dates and the lost reason.deal_lost_reason_idfillsdeal_lost_reasonwith the reason text.- Changing
pipeline_stage_idcloses the current stage in the stage history and opens the new one. - Changing
currency_idrecalculatesexchange_rateunless you send it. custom_fields_by_keyis merged with existing values; send a key withnullto clear it.
Request
Response
Returns the updated deal object with related data embedded (see embedded data).
json
Updating a deal triggers the organization's "deal updated" automations.
Report an issue with this documentation
Please log in to report issues with our documentation.