Skip to navigation

Create an opportunity status

View as Markdown

Create an opportunity status and add it to the end of a pipeline’s list of statuses. If you leave out pipeline_id, the status is added to your organization’s oldest pipeline. type defaults to active and can’t be changed later.

Returns 400 if the pipeline doesn’t exist, if your organization has no pipelines, if the pipeline already has a status with the same label (ignoring case), or if the pipeline already has 250 statuses. Requires the Manage Customizations permission, otherwise returns 403.

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.

Query parameters

_fieldsstringOptional

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

Request

This endpoint expects an object.
labelstringRequired>=1 character

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 to add the status to, prefixed with pipe_. Defaults to the organization’s oldest pipeline.

typeenumOptional

Whether opportunities in this status are open (active) or closed (won or lost). Can’t be changed later.

Allowed values:

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
429
Too Many Requests Error