Skip to main content
PATCH
Update a pipeline

Authorizations

Authorization
string
header
required

OAuth2 Authorization Code flow

Path Parameters

id
string
required

Pipeline ID

Body

application/json
name
string

Pipeline name

objectKind
enum<string>

Object kind this board organizes.

Available options:
report,
deal
description
object | null

Pipeline description

columns
object[]

Board columns (stages). Replaces the full set.

Response

200 - application/json
object
string
required

Object type

Example:

"page"

id
string
required

Unique identifier

Example:

"p_abc123"

createdAt
string<date-time>
required

Creation timestamp

Example:

"2024-01-15T10:30:00.000Z"

updatedAt
string<date-time>
required

Last update timestamp

Example:

"2024-01-15T14:45:00.000Z"

objectKind
enum<string>
required

Object kind this board organizes.

Available options:
report,
deal
name
string
required

Pipeline name

description
string | null
required
columns
object[]
required
createdBy
Created by · object

Principal who created this object

Example:
updatedBy
Updated by · object

Principal who last updated this object

Example:
icon
object | null

Pipeline icon