Actions30
- Account Actions
- Activity Actions
- Contact Actions
- Deal Actions
- GraphQL Actions
- Reporting Actions
- Webhook Actions
Deal → Update Deal (Per Deal-ID)
AI-generatedSummary
Update a Deal by its ID, optionally changing its name, pipeline/stage, associated fields, and adding an initial note.
Inputs
- dealId (required) — Pick a deal. Choose from the list, or specify an ID using an expression.
- name — Name of the Deal
- updatePipelineStage — Whether to update the deal's pipeline/stage
- pipelineId — Pipeline to update the deal in. Choose from the list, or specify an ID using an expression.
- stageId — Stage within the selected pipeline. Choose from the list, or specify an ID using an expression.
- fields — Fields to update. Leave fields empty to keep their current value.
- filterUnknownFields — Whether server-unknown errors should be filtered out during creation
- createInitialNote — Whether if enabled, a note will be created right after the deal is updated
- initialNoteText — Plain text (will be converted to Slate JSON)
- pinInitialNote — Pin Note?
- makeBold — Bold Note Text?
Output shape
a single updated Deal object
The response returns the updated Deal; fields not specified remain unchanged, and an error may be returned if the deal does not exist.
Examples
Example 1: Update a deal's name and move it to a new stage
dealId = '123', name = 'Acme Project', updatePipelineStage = true, pipelineId = '45', stageId = '67', createInitialNote = false
Example 2: Update custom fields and add an initial note
dealId = '456', fields = { "value1": "New Value" }, createInitialNote = true, initialNoteText = 'Closed successfully'
Example 3: Change only the pipeline and stage of a deal
dealId = '789', updatePipelineStage = true, pipelineId = '10', stageId = '11', makeBold = true