Archive pipeline
archive_pipelineArchive (soft-delete) a named pipeline by pipeline_key (or pipeline_id; id wins if both are given). Refused while live opportunities are still on it — reassign those deals to another pipeline first. Recoverable by an admin (soft-delete). The workspace default pipeline can't be archived. An unknown key/id returns the known pipelines instead of an error. Admin-only. Returns the archived pipeline.
When to use: When an admin no longer needs a named pipeline. Refused while deals are still on it — reassign those first; it stays recoverable by an admin.
Example: We're done with the Waitlist pipeline — archive it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pipeline_id | No | The pipeline to archive by id (uuid). id wins if both are given. | |
| pipeline_key | No | The pipeline to archive, by its stable key. Prefer this. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pipeline | No |