Update pipeline
update_pipelineUpdate a pipeline by pipeline_key (or pipeline_id; id wins if both are given) — rename it (label), re-point it (applies_to), replace its stages (including each stage's ENTRY requirements — the field keys a deal must have filled to move into it), or set which opportunity types default to it (default_for_types). Existing stage keys stay stable; a stage that still has open deals can't be removed (reassign those deals first). Omit BOTH pipeline_key and pipeline_id to reshape the WORKSPACE DEFAULT pipeline — only stages apply there (the default has no label, applies_to, or type mapping). An unknown key/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 what each stage requires on entry, re-point it, or set which deal types default onto it — or reshape the workspace default pipeline's stages (omit the pipeline key to target the default).
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?}], role one of unqualified/qualifying/active/commit/won/lost). Keep existing stage keys stable; a stage that still has open deals can't be removed. REPLACE-ALL: a stage you send without `requires` loses any requirements it had, so echo them back when you only mean to reorder or rename. | |
| 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 | The opportunity `type` VALUE KEYS this pipeline is the default for — new deals of a mapped type start on it. A type maps to only one pipeline. Pass [] to clear the mapping. Named pipelines only; registry data, not fixed type names. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pipeline | No |