Skip to main content
POST
Create a new pipeline

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

type
enum<string>
default:Contact
Available options:
Contact,
Application

Body

application/json
name
string
required

Pipeline display name; required and unique within the organization.

description
string

Optional human-readable summary of the pipeline's purpose.

isDefault
boolean

When true, becomes the org's default pipeline for its type (the previous default loses the flag).

stages
object[]

Legacy stage list used when pipelineStages is not provided; entries are mapped to new pipeline stages by newStage name.

pipelineStages
object[]

Stage definitions with name, color, and position (sort order); takes precedence over stages and must be non-empty.

Response

Pipeline created

message
string
pipeline
object
Example:
contactsMigrated
object