There's a new version of the HubSpot API

Starting November 30, 2022, API keys will be sunset as an authentication method. Learn more about this change and how to migrate an API key integration to use a private app instead.

Create a Deal Pipeline

Last updated June 17, 2020

POST /deals/v1/pipelines

Note: The Deals Pipelines API is deprecated. Please use the CRM Pipelines API to manage deal pipelines.

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

CRM

This endpoint will create a new deal pipeline. The API will automatically generate a unique pipelineId for the pipeline.

The request may specify dealstages for the pipeline. If dealstages are omitted, the API will automatically generate a default set of dealstages for the pipeline. Every saved pipeline has at least one dealstage.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.

Pipeline fields:

  • label: (String) Human-readable display name of the pipeline
  • displayOrder: (int) The order pipelines will be displayed in the UI
  • stages: (List<Dealstage>) The list of Dealstages in this pipeline (see below for Dealstage object)

Dealstage fields:

  • label: (String) Human-readable display name of the pipeline. Must be unique within the pipeline.
  • displayOrder: (int) The order within the pipeline the dealstage will be displayed in the UI
  • stages: (List<Dealstage>) The list of dealstages in this pipeline
  • stageId: (String) (Optional) Internal value of the dealstage. If specified, must be unique across all dealstage (regardless of pipeline). If omitted, a unique stageId will be generated automatically by the API. We recommend omitting stageId and allowing the API to generate it, unless specific stageIds are desired (e.g. for a custom integration).
  • probability: (double) Decimal probability of the dealstage closing, in the range [0.0,1.0] where 1.0 represents a closed won deal. The UI will display probability as a percentage, rounded to the nearest 10%.

You can read more about how Deal Pipelines and how they work in our Deal Pipelines Overview.