The Pipelines endpoints are used to view, create, and manage pipelines in the HubSpot CRM and service tools.
POST
request to /crm/v3/pipelines/{objectType}
. In the request body, include the following:
displayOrder
: a number that decides the order the pipeline is displayed within all pipelines of the object. If multiple pipelines are the same number in the order, they’ll be listed alphabetically by label.label
: the name of the pipeline as it is displayed in HubSpot.stages
: inputs to set the stages in the pipeline. For each stage, include the following:
metadata
: properties related to the stage, optional for all objects except deals. For deals, probability
is required with a value between 0.0
and 1.0
, 0.0
being Closed Lost and 1.0
being Closed Won. For tickets, you can include ticketState
with a value of either OPEN
or CLOSED
.displayOrder
: a number that decides the order in which the stage will be displayed.label
: the stage name. This must be unique for each stage.PUT
request to /crm/v3/pipelines/{objectType}/{pipelineId}
with the id
of the pipeline to replace. In the request body, include the fields required when creating a new pipeline. The information you add in the request body will overwrite the existing pipeline’s details.
GET
request to /crm/v3/pipelines/{objectType}
. Each pipeline’s id
, label
, and displayOrder
values will be returned, along with information about when it was created or updated. You can use the id
values to retrieve and update individual pipelines.GET
request to /crm/v3/pipelines/{objectType}/{pipelineId}
.PATCH
request to /crm/v3/pipelines/{objectType}/{pipelineId}
. In the request body, include the properties to update.
If you want to edit a pipeline’s stages, use the stage endpoints.
DELETE
request to /crm/v3/pipelines/{objectType}/{pipelineId}
. To check if there are records in the pipeline, include the validateReferencesBeforeDelete
parameter with a value of true
. When the parameter is included, you’ll be notified of existing records and cannot delete the pipeline until the records have been deleted or moved to a different pipeline.
If there are existing records, your response will look similar to the following:
POST
request to /crm/v3/pipelines/{objectType}/{pipelineId}/stages
.
In the request body, include the following:
displayOrder
: a number that decides the order of the stage in the pipeline. If multiple stages are the same number in the order, they’ll be listed alphabetically by label.label
: the name of the stage as it is displayed in HubSpot.metadata
: an object that includes properties for the stage, optional for all objects except deals. For deals, probability
is required with a value between 0.0
and 1.0
, 0.0
being Closed Lost and 1.0
being Closed Won. For tickets, you can include ticketState
with a value of OPEN
or CLOSED
.PUT
request to /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}
with the id
of the stage to replace. In the request body, include the fields required when creating a new stage. The information you add in the request body will overwrite the existing stage’s details.
GET
request to /crm/v3/pipelines/{objectType}/{pipelineId}/stages
. Each stage’s id
, label
, and displayOrder
values will be returned, along with information about when it was created or updated. You can use the id
values to retrieve and update individual stages.GET
request to /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}
.PATCH
request to /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}
. In the request body, include the properties to update.
DELETE
request to /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}
.
GET
request to /crm/v3/pipelines/{objectType}/{pipelineId}/audit
.GET
request to /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}/audit
.