Partially update a pipeline

curl --request PATCH \ --url https://api.hubapi.com/crm/pipelines/2026-03/{objectType}/{pipelineId} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "archived": true, "displayOrder": 123, "label": "<string>" } '

{ "archived": true, "createdAt": "2023-11-07T05:31:56Z", "displayOrder": 123, "id": "<string>", "label": "<string>", "stages": [ { "archived": true, "createdAt": "2023-11-07T05:31:56Z", "displayOrder": 123, "id": "<string>", "label": "<string>", "metadata": {}, "updatedAt": "2023-11-07T05:31:56Z", "archivedAt": "2023-11-07T05:31:56Z" } ], "updatedAt": "2023-11-07T05:31:56Z", "archivedAt": "2023-11-07T05:31:56Z" }

Supported products

Required Scopes

承認

Authorization

string

header

必須

The access token received from the authorization server in the OAuth 2.0 flow.

パスパラメータ

objectType

string

必須

pipelineId

string

必須

クエリパラメータ

validateDealStageUsagesBeforeDelete

boolean

デフォルト:false

validateReferencesBeforeDelete

boolean

デフォルト:false

ボディ

application/json

archived

boolean

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.

displayOrder

integer<int32>

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

label

string

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

レスポンス

successful operation

archived

boolean

必須

Whether the pipeline is archived.

createdAt

string<date-time>

必須

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

displayOrder

integer<int32>

必須

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

string

必須

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

label

string

必須

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

stages

object[]

必須

The stages associated with the pipeline. They can be retrieved and updated via the pipeline stages endpoints.

Show child attributes

updatedAt

string<date-time>

必須

The date the pipeline was last updated.

archivedAt

string<date-time>

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