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" sets won_date; status: "lost" sets lost_date; status: "open" clears both dates and the lost reason.
  • deal_lost_reason_id fills deal_lost_reason with the reason text.
  • Changing pipeline_stage_id closes the current stage in the stage history and opens the new one.
  • Changing currency_id recalculates exchange_rate unless you send it.
  • custom_fields_by_key is merged with existing values; send a key with null to 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.