There's a new version of the HubSpot API

Check out the new API
View Beta Docs

We're also working on a new documentation website, you're invited to check it out and give us your feedback.

Update an existing pipeline

Last updated May 31, 2023

PUT /crm-pipelines/v1/pipelines/:object_type/:pipeline_id

Method Details

HTTP Methods:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

CRM and Service Hub

Update an existing pipeline for the specified object type.
Required Parameters How to use Description
OAuth access token or private app access token Authorization: Bearer {token} header Used to authenticate the request. Please see this page for more details about authentication.
Object Type /:object_type
Used in the request URL 

The object type of the pipeline that you want to update.

Must be one of:

  • tickets
  • deals
Pipeline ID /:pipeline_id
Used in the request URL		 The ID of the pipeline you want to update.
Pipeline JSON Used in the request body  The details of the pipeline you want to update. See creating a pipeline for a description of the fields that may be included.

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example PUT URL, updating an existing pipeline for TICKETS: https://api.hubapi.com/crm-pipelines/v1/pipelines/tickets/api_test_pipeline_tickets Example PUT data: { "label": "Updated ticket pipeline", "displayOrder": 2, "active": true, "stages": [ { "stageId": "example_stage", "createdAt": 1531316781557, "updatedAt": null, "label": "Example stage", "displayOrder": 1, "metadata": { "ticketState": "OPEN" }, "active": true }, { "stageId": "another_example_stage", "createdAt": 1531316781557, "updatedAt": null, "label": "Another example stage", "displayOrder": 2, "metadata": { "ticketState": "OPEN" }, "active": true }, { "stageId": "additional_example_stage", "createdAt": 1531316781557, "updatedAt": null, "label": "Additional example stage", "displayOrder": 2, "metadata": { "ticketState": "CLOSED" }, "active": true } ] } Example PUT URL, updating an existing pipeline for DEALS: https://api.hubapi.com/crm-pipelines/v1/pipelines/deals/api_test_pipeline_deals Example PUT data: { "label": "Updated Deal pipeline", "displayOrder": 2, "active": true, "stages": [ { "stageId": "example_stage", "createdAt": 1531316781557, "updatedAt": null, "label": "Example stage", "displayOrder": 1, "metadata": { "probability": 0.3 }, "active": true }, { "stageId": "another_example_stage", "createdAt": 1531316781557, "updatedAt": null, "label": "Another example stage", "displayOrder": 2, "metadata": { "probability": 0.5 }, "active": true }, { "stageId": "additional_example_stage", "createdAt": 1531316781557, "updatedAt": null, "label": "Additional example stage", "displayOrder": 2, "metadata": { "probability": 1.0 }, "active": true } ] } Example Response: { "pipelineId": "api_test_pipeline", "createdAt": 1531316781557, "updatedAt": 1532367855541, "objectType": "TICKET", "label": "Updated ticket pipeline", "displayOrder": 2, "active": true, "stages": [ { "stageId": "another_example_stage", "createdAt": 0, "updatedAt": 1532367855541, "label": "Another example stage", "displayOrder": 2, "metadata": {}, "active": true }, { "stageId": "example_stage", "createdAt": 0, "updatedAt": 1532367855541, "label": "Example stage", "displayOrder": 1, "metadata": {}, "active": true }, { "stageId": "additional_example_stage", "createdAt": 0, "updatedAt": null, "label": "Additional example stage", "displayOrder": 2, "metadata": {}, "active": true } ], "default": false }