Move a deal (also called an opportunity) to another stage of its pipeline
POST
/api/v1/deals/{id}/move-stage
The only way to change a deal’s stage. The stage must be a stage of the deal’s own pipeline (see pipeline_stages_list). Moving into a won or lost stage closes the deal (closed_at); moving to an open stage reopens it. Moving to the stage the deal is already in changes nothing. Emits deal.stage_changed.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” id
required
string format: uuid
Request Body required
Section titled “Request Body required ”object
stage_id
required
string format: uuid
Responses
Section titled “ Responses ”Success
object
id
required
string format: uuid
organization_id
required
string format: uuid
name
required
string
pipeline_id
required
string format: uuid
stage_id
required
string format: uuid
status
The kind of the deal’s stage: open, won or lost. Derived, read-only.
string
amount_minor
required
integer | null
currency
required
string | null
expected_close_date
required
string | null
owner_id
required
string | null format: uuid
closed_at
required
string | null
created_by
required
string format: uuid
created_at
required
string
updated_at
required
string