Skip to navigation

Rename an opportunity status

View as Markdown

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

AuthorizationBasic
Use your API key as the username and leave the password empty.
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
ID of the opportunity status.

Query parameters

_fieldsstringOptional

Comma-separated list of fields to include in the response.

Request

This endpoint expects an object.
labelstringRequired>=1 character

New name of the opportunity status. Leading and trailing whitespace is removed. Must be unique within the pipeline (ignoring case).

pipeline_idstring or nullOptional

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

Successful response
idstring

Unique ID of the opportunity status, prefixed with stat_.

labelstring

Name of the opportunity status, unique within its pipeline (ignoring case).

organization_idstring
ID of the organization the opportunity status belongs to.
typeenum

Whether opportunities in this status are open (active) or closed (won or lost).

Allowed values:
pipeline_idstringOptional

ID of the pipeline the opportunity status belongs to, prefixed with pipe_.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error