---
title: "Update pipeline name/description"
method: PATCH
path: "/pipelines/{pipeline_id}"
tags: ["Pipeline"]
---

# Update pipeline name/description

`PATCH /pipelines/{pipeline_id}`

Updates the name and/or description of a pipeline.

## Path parameters

- `pipeline_id` string, required

## Request body

- PipelineUpdateRequest
  - `name` string, nullable
  - `description` string, nullable

## Response `200`

Successful Response

- Pipeline — Model for representing a pipeline in API list responses (without elements).
  - `id` string, required
  - `project_id` string, required
  - `user_id` string, nullable
  - `name` string, required
  - `description` string, nullable
  - `options` PipelineOptions — Options for pipeline execution behavior.
    - `live_progress_updates` boolean, nullable — If True, save checkpoint progress to database during job execution. If None, the worker picks a default based on job type.
  - `status` 'pending' | 'running' | 'completed' | 'failed' | 'canceled', required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `error` string, nullable
  - `error_code` 'CONFIGURATION_ERROR' | 'MODEL_ERROR' | 'SOLVER_ERROR' | 'EXECUTION_TIMEOUT' | 'SUBMISSION_FAILED' | 'INTERNAL_ERROR' — Machine-readable error codes for jobs.
  - `created_by_email` string, nullable
  - `organization_id` string, required — Organization this pipeline belongs to.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/ionworks/apis/fastapi.md) · [All operations](https://skmtc.dev/ionworks/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ionworks/fastapi/revisions/7337a3cbdaf2/schema)