Skip to main content
POST
/
crm-pipelines
/
v1
/
pipelines
/
{object_type}
Create a new pipeline
curl --request POST \
  --url https://api.hubapi.com/crm-pipelines/v1/pipelines/{object_type} \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "displayOrder": 123,
  "active": true,
  "stages": [
    {
      "stageId": "<string>",
      "label": "<string>",
      "displayOrder": 123,
      "metadata": {
        "probability": 0.5
      },
      "active": true
    }
  ],
  "pipelineId": "<string>"
}
'
{
  "pipelineId": "<string>",
  "createdAt": 123,
  "updatedAt": 123,
  "objectType": "DEAL",
  "label": "<string>",
  "displayOrder": 123,
  "active": true,
  "default": true,
  "stages": [
    {
      "stageId": "<string>",
      "createdAt": 123,
      "updatedAt": 123,
      "label": "<string>",
      "displayOrder": 123,
      "active": true,
      "metadata": {
        "probability": 0.5
      }
    }
  ]
}

Path Parameters

​
object_type
enum<string>
required

The object type that you are creating the pipeline for. Must be one of: deals, tickets

Available options:
deals,
tickets

Body

application/json
​
label
string
required

The label for the pipeline. The label will be displayed when viewing records in HubSpot. The label is limited to 36 characters.

Maximum string length: 36
​
displayOrder
integer
required

When viewing records in HubSpot, pipelines are displayed starting with the pipeline with the lowest displayOrder value.

​
active
boolean
required

Whether or not the pipeline is active. This should be true for new pipelines, otherwise they will not be available to use when updating or editing records.

​
stages
object[]
required

A list of stages for this pipeline. Pipelines may have up to 100 stages.

Maximum array length: 100
​
pipelineId
string

The internal ID for the new pipeline. The ID must be unique across pipelines for the specified object type. This ID will be automatically generated if not included when creating the pipeline. The ID is limited to 36 characters.

Maximum string length: 36

Response

201 - application/json

Successfully created pipeline

​
pipelineId
string
​
createdAt
integer<int64>
​
updatedAt
integer<int64> | null
​
objectType
enum<string>
Available options:
DEAL,
TICKET
​
label
string
​
displayOrder
integer
​
active
boolean
​
default
boolean
​
stages
object[]