---
title: "Update pipeline"
method: POST
path: "/v2/pipelines/{pipelineKey}"
tags: ["Pipelines"]
---

# Update pipeline

`POST /v2/pipelines/{pipelineKey}`

## Request

- Base URL: `https://api.streak.com/api`
- URL: `https://api.streak.com/api/v2/pipelines/{pipelineKey}`
- Auth: HTTP bearer

Updates the supplied Pipeline fields. Omitted fields remain unchanged.

## Path parameters

- `pipelineKey` string, required

## Request body

- PipelineUpdate
  - `teamKey` string, nullable: New team key. Omit to keep the current team.
  - `icon` string, nullable: New icon. Omit to keep the current icon.
  - `name` string, nullable: New name. Omit to keep the current name.
  - `description` string, nullable: New description. Omit to keep the current description.
  - `sharingRestrictedToTeam` boolean, nullable: New team sharing restriction. Omit to keep the current value.
  - `stageOrder` string[], nullable: Complete stage order. Omit to keep the current order; an empty list is invalid.
  - `stageColorTheme` 'DEFAULT' | 'STREAK' | 'RAINBOW_SATURATED' | 'RAINBOW_FADED' | 'TRAFFIC_LIGHT_SATURATED' | 'TRAFFIC_LIGHT_FADED' | 'LAKESIDE_SATURATED' | 'LAKESIDE_FADED' | 'SUNSET_SATURATED' | 'SUNSET_FADED' | 'SUMMER_SATURATED' | 'SUMMER_FADED' | 'HALLOWEEN_SATURATED' | 'HALLOWEEN_FADED' | 'GREYSCALE' | 'BLUEGREY' | 'RED' | 'YELLOWORANGE' | 'GREEN' | 'TEAL' | 'CYAN' | 'BLUE' | 'INDIGO' | 'DEEPPURPLE' | 'VIOLET' | 'PINK', nullable: New stage color theme. Omit to keep the current theme.
  - `customPermissionSets` object, nullable: Replacement custom permission sets. Omit to keep existing sets.
  - `defaultPermissionSetName` string, nullable: New default permission set. Omit to keep the current value.
  - `aclEntries` PipelineSharingEntryInput[], nullable: Replacement sharing entries. Omit to keep existing sharing; an empty list is invalid.
    - `userKey` string, nullable: Key for the user to share with. Takes precedence over email when both are provided.
    - `email` string, nullable: Email address used to find or create the user when userKey is omitted.
    - `permissionSetName` string, required: Permission set to assign to the user.

## Response `200`

OK

- Pipeline
  - `key` string, required: Key for this pipeline.
  - `teamKey` string, nullable: Key for the team that owns this pipeline.
  - `creatorKey` string, required: Key for the user who created this pipeline.
  - `name` string, required: Pipeline name.
  - `icon` string, required: Pipeline icon name.
  - `description` string, nullable: Pipeline description.
  - `sharingRestrictedToTeam` boolean, nullable: Whether sharing is restricted to the team.
  - `fields` PipelineField[], required: Custom fields configured for this pipeline.
    - `key` string, required: Field key within the pipeline.
    - `name` string, required: Field name.
    - `type` 'TEXT_INPUT' | 'DROPDOWN' | 'CHECKBOX' | 'DATE' | 'PERSON' | 'FORMULA' | 'TAG' | 'TEAM_CONTACT' | 'TEAM_ORGANIZATION', required
    - `defaultValue` unknown
    - `lastDefaultValueUpdatedTimestamp` integer, nullable: Timestamp when the default value last changed, in epoch milliseconds.
    - `lastUpdatedTimestamp` integer, nullable: Timestamp when this field last changed, in epoch milliseconds.
    - `dropdownSettings` object, nullable: Dropdown options when this is a dropdown field.
      - `items` PipelineDropdownItem[], required: Available dropdown options.
        - `key` string, nullable: Option key.
        - `name` string, required: Option name.
    - `tagSettings` object, nullable: Tag options when this is a tag field.
      - `tags` PipelineTagItem[], required: Available tags.
        - `key` string, required: Tag key.
        - `tag` string, required: Tag label.
    - `aiSettings` PipelineAiSettings, required
      - `prompt` string, required: Prompt used for AI autofill.
      - `source` 'BOX_TIMELINE' | 'WEB_CRAWLING', required: Content used as context for AI autofill. BOX_TIMELINE uses the pipeline item's timeline; WEB_CRAWLING uses content found on the web.
  - `stages` object, required: Stages in this pipeline, keyed by stage key.
  - `stageOrder` string[], required: The display order of the stages
  - `stageColorTheme` 'DEFAULT' | 'STREAK' | 'RAINBOW_SATURATED' | 'RAINBOW_FADED' | 'TRAFFIC_LIGHT_SATURATED' | 'TRAFFIC_LIGHT_FADED' | 'LAKESIDE_SATURATED' | 'LAKESIDE_FADED' | 'SUNSET_SATURATED' | 'SUNSET_FADED' | 'SUMMER_SATURATED' | 'SUMMER_FADED' | 'HALLOWEEN_SATURATED' | 'HALLOWEEN_FADED' | 'GREYSCALE' | 'BLUEGREY' | 'RED' | 'YELLOWORANGE' | 'GREEN' | 'TEAL' | 'CYAN' | 'BLUE' | 'INDIGO' | 'DEEPPURPLE' | 'VIOLET' | 'PINK', required
  - `creationTimestamp` integer, required: Timestamp when the pipeline was created, in epoch milliseconds.
  - `lastUpdatedTimestamp` integer, required: Timestamp when the pipeline was last updated, in epoch milliseconds.
  - `formulasLastUpdatedTimestamp` integer, nullable: Latest formula-definition update timestamp, in epoch milliseconds.
  - `customPermissionSets` object, required: Custom permission sets configured for this pipeline.
  - `defaultPermissionSetName` string, required: Default permission set assigned to users without an explicit assignment.
  - `aclEntries` PipelineSharingEntry[], required: Users explicitly sharing this pipeline and their permission assignments.
    - `userKey` string, required: Key for the shared user.
    - `permissionSetName` string, required: Permission set assigned to the user.
    - `email` string, nullable: User email address.
    - `displayName` string, nullable: User display name.
    - `fullName` string, nullable: User full name.
    - `givenName` string, nullable: User given name.
    - `image` string, nullable: User profile image URL.
    - `userType` 'HUMAN' | 'AGENT', nullable: User account type.
    - `isReadOnly` boolean, nullable: Whether the sharing entry is read-only.
  - `creationSourceType` 'HUMAN' | 'SYSTEM_ONBOARDING' | 'AI_PIPELINE_CREATOR', required
  - `boxCount` integer: Current number of boxes in the pipeline.
  - `lastSavedTimestamp` integer, required: Timestamp when the pipeline was last persisted, in epoch milliseconds.

## Changes

- **2026-10-16** `1c3a5ef8b9ea`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/streakyc/apis/streak/changes/v2/pipelines/:pipelineKey/post.md)

---

[API](https://skmtc.dev/streakyc/apis/streak.md) - [All operations](https://skmtc.dev/streakyc/apis/streak/llms.txt) - [OpenAPI document](https://skmtc.dev/streakyc/apis/streak/revisions/3648671fd1cf?raw)