curl --request POST \
--url https://api.hubapi.com/crm/v3/pipelines/{objectType} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayOrder": 0,
"label": "My replaced pipeline",
"stages": [
{
"displayOrder": 0,
"label": "In Progress",
"metadata": {
"ticketState": "OPEN"
}
},
{
"displayOrder": 1,
"label": "Done",
"metadata": {
"ticketState": "CLOSED"
}
}
]
}
'{
"archived": false,
"createdAt": "2019-10-30T03:30:17.883Z",
"displayOrder": 0,
"id": "812723471",
"label": "My ticket pipeline",
"stages": [
{
"archived": false,
"createdAt": "2019-10-30T03:30:17.883Z",
"displayOrder": 0,
"id": "1234912",
"label": "In Progress",
"metadata": {
"ticketState": "OPEN"
},
"updatedAt": "2019-12-07T16:50:06.678Z"
},
{
"archived": false,
"createdAt": "2019-10-30T03:30:17.883Z",
"displayOrder": 0,
"id": "1234914",
"label": "Done",
"metadata": {
"ticketState": "CLOSED"
},
"updatedAt": "2019-12-07T16:50:06.678Z"
}
],
"updatedAt": "2019-12-07T16:50:06.678Z"
}Create a pipeline
Create a new pipeline with the provided property values. The entire pipeline object, including its unique ID, will be returned in the response.
curl --request POST \
--url https://api.hubapi.com/crm/v3/pipelines/{objectType} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayOrder": 0,
"label": "My replaced pipeline",
"stages": [
{
"displayOrder": 0,
"label": "In Progress",
"metadata": {
"ticketState": "OPEN"
}
},
{
"displayOrder": 1,
"label": "Done",
"metadata": {
"ticketState": "CLOSED"
}
}
]
}
'{
"archived": false,
"createdAt": "2019-10-30T03:30:17.883Z",
"displayOrder": 0,
"id": "812723471",
"label": "My ticket pipeline",
"stages": [
{
"archived": false,
"createdAt": "2019-10-30T03:30:17.883Z",
"displayOrder": 0,
"id": "1234912",
"label": "In Progress",
"metadata": {
"ticketState": "OPEN"
},
"updatedAt": "2019-12-07T16:50:06.678Z"
},
{
"archived": false,
"createdAt": "2019-10-30T03:30:17.883Z",
"displayOrder": 0,
"id": "1234914",
"label": "Done",
"metadata": {
"ticketState": "CLOSED"
},
"updatedAt": "2019-12-07T16:50:06.678Z"
}
],
"updatedAt": "2019-12-07T16:50:06.678Z"
}Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Body
An input used to create or replace a pipeline's definition.
The order for displaying this pipeline stage. If two pipeline stages have a matching displayOrder, they will be sorted alphabetically by label.
A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.
The stages associated with the pipeline. They can be retrieved and updated via the pipeline stages endpoints.
Show child attributes
Show child attributes
Response
successful operation
A pipeline definition.
Whether the pipeline is archived.
The date the pipeline stage was created. The stages on default pipelines will have createdAt = 0.
The order for displaying this pipeline stage. If two pipeline stages have a matching displayOrder, they will be sorted alphabetically by label.
A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline stage.
A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.
The stages associated with the pipeline. They can be retrieved and updated via the pipeline stages endpoints.
Show child attributes
Show child attributes
The date the pipeline stage was last updated.
The date the pipeline was archived. archivedAt will only be present if the pipeline is archived.
Was this page helpful?