Update Stage
Deals
Update a Stage
PATCH
Update Stage
All body fields are optional and partial — only fields present are changed. Setting
position here is not atomic with other stages’ positions; use Reorder Stages for a bulk move.
Auth
Requires the org-admin scopeorganizations:manage specifically — the CRM manage scopes the rest of the deals router accepts are not enough here — plus an active organization on the token.
Response
The updated stage row — same shape as List All Stages. If the body has no non-null fields, returns the stage unchanged without a write.Errors
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The pipeline stage's id.
Body
application/json
New stage name.
Required string length:
1 - 80New hex color for the stage chip/column.
New default win probability, 0.0-1.0.
Required range:
0 <= x <= 1Toggle whether this is a Closed Won terminal stage.
Toggle whether this is a Closed Lost terminal stage.
Hide the stage from non-admin views; blocked while it holds the last visible Won/Lost stage.
New sort position.
Response
Successful Response