Skip to main content
POST
Bulk create pipeline stages

Authorizations

x-api-key
string
header
required

Personal API key. Requests act as the workspace member who created the key, with that member's current access, and stop working when the key is disabled or its creator leaves the workspace.

Path Parameters

pipeline_id
string<uuid>
required

Pipeline ID.

Body

application/json

Array of pipeline stages to create. Maximum 100 items.

Required array length: 1 - 100 elements
label
string
required
Maximum string length: 255
color
string
Maximum string length: 32
stage_order
integer | null
Required range: x >= 1
is_default
boolean
probability
number | null
Required range: 0 <= x <= 100
stage_type
enum<string>
Available options:
default,
positive,
negative
description
string | null

Free-text guidance for the stage. Leading and trailing whitespace is trimmed before the length is checked. Empty or null means none.

Maximum string length: 5000

Response

Pipeline stages were created.

success
boolean
Example:

true

message
string
data
any

Endpoint-specific response payload.