Update Pipeline

PUT 
/opportunities/pipelines/:pipelineId

Updates an existing pipeline. The stages array is a full replacement — include the id field on existing stages to retain them, or omit it to create a new stage. You cannot remove all stages at once. Any opportunities in removed stages are automatically migrated to the lowest-position remaining stage. Pipeline and stage names must remain unique (case-insensitive) within the location. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-709536/75a21483123abd7

Request

Version stringrequired

API Version

Available options2021-04-15

pipelineId stringrequired

The unique identifier of the pipeline

application/json

application/json

Body

Bodyrequired

namestring

Name of the pipeline

stagesstring[]

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

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,
  "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"
}