---
title: "Update Pipeline"
method: PUT
path: "/pipelines/{pipeline_id}"
tags: ["CLI Pipelines"]
---

# Update Pipeline

`PUT /pipelines/{pipeline_id}`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/pipelines/{pipeline_id}`
- Auth: HTTP bearer

Rename, retarget, and/or promote a pipeline to default.

## Path parameters

- `pipeline_id` string, required

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- PipelineUpdateRequest
  - `name` string, nullable
  - `target` string, nullable
  - `set_default` boolean

## Response `200`

Successful Response

- ApiResponsePipelineResponse
  - `data` PipelineResponse, required
    - `id` string, required
    - `name` string, required
    - `is_default` boolean
    - `stages` PipelineStageResponse[]
      - `id` string, required
      - `name` string, required
      - `probability` integer, nullable
      - `position` integer, nullable
      - `stage_type` string, nullable
      - `color` string, nullable
      - `required_elements` string[]
      - `recommended_elements` string[]
      - `channel_scripts` object
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)