CRM ConfigurationOpportunity Statuses

Create an opportunity status

View as Markdown

Create a new opportunity status. The status must belong to a pipeline (specified by pipeline_id) and have a type of active, won, or lost.

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
pipeline_idstring or nullOptional
typeenumOptional

Response

Successful response
idstring
labelstring
organization_idstring
typeenum
pipeline_idstringOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error