Create Pipeline

POST 
/opportunities/pipelines

Creates a new pipeline with at least one stage for a given location. Pipeline names must be unique per location (case-insensitive), and stage names must be unique within the pipeline. To enable manual win probability, set useOpportunityProbability to true and provide a stageWinProbability (0–100) on every stage — if any stage is missing a value, the system falls back to auto-computed probabilities based on stage position.

Request

Version stringrequired

API Version

Available options2021-04-15

application/json

application/json

Body

Bodyrequired

namestringrequired

Name of the pipeline

stagesstring[]required

List of stages belonging to this pipeline

showInFunnelboolean

Whether the pipeline is shown in the funnel view

showInPieChartboolean

Whether the pipeline is shown in the pie chart view

useOpportunityProbabilityboolean

Whether stage-level win probability is enabled for this pipeline

locationIdstringrequired

Identifier of the location (sub-account) this pipeline belongs to

colorRenderModestring
How pipeline/stage colors are rendered
Available optionsdotbg-tintnone

Example (auto)

{
  "name": "pipeline",
  "stages": [
    {
      "name": "stage 1",
      "position": 1,
      "showInFunnel": true
    }
  ],
  "showInFunnel": false,
  "showInPieChart": true,
  "useOpportunityProbability": true,
  "locationId": "ve9EPM428h8vShlRW1KT",
  "colorRenderMode": "dot"
}

application/json

Successful response

application/json

Schema

Schema

idstring

Unique identifier of the pipeline

namestring

Name of the pipeline

stagesarray[]

Stages belonging to this pipeline

showInFunnelboolean

Whether the pipeline is shown in the funnel view

showInPieChartboolean

Whether the pipeline is shown in the pie chart view

locationIdstring

Identifier of the location (sub-account) this pipeline belongs to

useOpportunityProbabilityboolean

Whether stage-level win probability is enabled for this pipeline

colorRenderModestring
How pipeline/stage colors are rendered
Available optionsdotbg-tintnone
positionstring

Fractional-index key used to sort pipelines. Updated when the user reorders pipelines (via drag-and-drop or the reorder modal).

Example (auto)

{
  "id": "aWdODOBVOlH1RUFKWQke",
  "name": "new pipeline",
  "stages": [],
  "showInFunnel": false,
  "showInPieChart": true,
  "locationId": "VeMHYX28Satp2p7XVKbb",
  "useOpportunityProbability": true,
  "colorRenderMode": "dot",
  "position": "a0V"
}