Update pipeline
update_pipelineUpdate a pipeline by pipeline_key (or pipeline_id; id wins): rename it (label), re-point it (applies_to), replace its stages (including each stage's entry requirements) or set which opportunity types default to it (default_for_types). Existing stage keys stay stable; a stage with open deals can't be removed (reassign them first). Omit both key and id to reshape the WORKSPACE DEFAULT pipeline — only stages apply there. An unknown key or id returns the known pipelines instead of an error. Admin-only. Returns the updated pipeline.
When to use: When an admin wants to rename a pipeline, change its stages or their entry requirements, re-point it, or set which deal types default onto it; omit the pipeline key to reshape the workspace default pipeline's stages.
Example: Don't let a deal reach Proposal until Metrics and an economic buyer are filled in.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| label | No | Rename the pipeline. | |
| stages | No | Replace the stage list ([{key,label,role,is_closed?,is_won?,requires?,requires_mode?}]). Keep existing keys stable; a stage with open deals can't be removed. Replace-all: a stage sent without `requires` loses its requirements, so echo them back when only renaming or reordering. | |
| applies_to | No | The object key this pipeline runs on (e.g. opportunity). Named pipelines only. | |
| pipeline_id | No | The pipeline to edit by id (uuid). Prefer pipeline_key; id wins if both are given. | |
| pipeline_key | No | The named pipeline to edit, by its stable key (from describe_schema's pipelines section). Omit BOTH pipeline_key and pipeline_id to edit the workspace default pipeline (only `stages` applies there). | |
| default_for_types | No | Opportunity `type` value keys this pipeline is the default for — new deals of a mapped type start on it; a type maps to one pipeline. Pass [] to clear. Named pipelines only; registry value keys, not fixed type names. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pipeline | No |