Sign in

v14

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-279719892.3 MB
Basic

Perform a partial update of the pipeline identified by {pipelineId}. The updated pipeline will be returned in the response.

patch/crm/pipelines/2026-03/{objectType}/{pipelineId}

Path parameters

objectTypestring required
pipelineIdstring required

Query parameters

validateDealStageUsagesBeforeDeleteboolean
validateReferencesBeforeDeleteboolean

Request body

archivedboolean

Whether the pipeline is archived. This property should only be provided when restoring an archived pipeline. If it's provided in any other call, the request will fail and a 400 Bad Request will be returned.

displayOrderinteger

The order for displaying this pipeline. If two pipelines have a matching displayOrder, they will be sorted alphabetically by label.

labelstring

A unique label used to organize pipelines in HubSpot's UI

Response

successful operation

archivedboolean required

Whether the pipeline is archived.

archivedAtstring date-time

The date the pipeline was archived. archivedAt will only be present if the pipeline is archived.

createdAtstring date-time required

The date the pipeline was created. The default pipelines will have createdAt = 0.

displayOrderinteger required

The order for displaying this pipeline. If two pipelines have a matching displayOrder, they will be sorted alphabetically by label.

idstring required

A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline.

labelstring required

A unique label used to organize pipelines in HubSpot's UI

updatedAtstring date-time required

The date the pipeline was last updated.