Rename an opportunity status
Rename an opportunity status. Only label can be changed: type is ignored, and opportunities that use the status keep it and show the new label. Returns 400 if another status in the same pipeline already has the label (ignoring case). Requires the Manage Customizations permission, otherwise returns 403.
pipeline_id is accepted but can’t move the status. Any value other than the status’s current pipeline returns 400. To move a status to another pipeline, use PUT /pipeline/{id}/.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Query parameters
Comma-separated list of fields to include in the response.
Request
New name of the opportunity status. Leading and trailing whitespace is removed. Must be unique within the pipeline (ignoring case).
ID of the pipeline the status belongs to. Optional, and it can’t move the status: any other pipeline returns 400. To move a status to another pipeline, use the Pipelines API.
Response
Unique ID of the opportunity status, prefixed with stat_.
Name of the opportunity status, unique within its pipeline (ignoring case).
Whether opportunities in this status are open (active) or closed (won or lost).
ID of the pipeline the opportunity status belongs to, prefixed with pipe_.