Update a Deal Pipeline

PUT /deals/v1/pipelines/:pipelineId

Method Details

HTTP Methods:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

CRM

This endpoint will overwrite an existing deal pipeline.

The request must specify dealstages for the pipeline. The dealstages included in the request will overwrite the existing dealstages for the pipeline, including deleting previously existing dealstages that are not included in the updated pipeline request.

If you're removing a dealstage from a pipeline, we strongly recommend moving existing deals into a different dealstage first.

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.
pipelineId  Used in the request URL (see above)  Unique identifier for a particular Deal Pipeline in HubSpot CRM. 

Pipeline fields:

  • label: (String) Human-readable display name of the pipeline
  • pipelineId: (String) Internal id 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.