Zum Hauptinhalt springen
PATCH
/
crm
/
v3
/
pipelines
/
{objectType}
/
{pipelineId}
cURL
curl --request PATCH \
  --url https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "label": "My updated pipeline",
  "displayOrder": 0
}'
{
  "label": "My ticket pipeline",
  "displayOrder": 0,
  "createdAt": "2019-10-30T03:30:17.883Z",
  "updatedAt": "2019-12-07T16:50:06.678Z",
  "archived": false,
  "id": "812723471",
  "stages": [
    {
      "label": "In Progress",
      "displayOrder": 0,
      "metadata": {
        "ticketState": "OPEN"
      },
      "createdAt": "2019-10-30T03:30:17.883Z",
      "updatedAt": "2019-12-07T16:50:06.678Z",
      "archived": false,
      "id": "1234912"
    },
    {
      "label": "Done",
      "displayOrder": 0,
      "metadata": {
        "ticketState": "CLOSED"
      },
      "createdAt": "2019-10-30T03:30:17.883Z",
      "updatedAt": "2019-12-07T16:50:06.678Z",
      "archived": false,
      "id": "1234914"
    }
  ]
}
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub -無料ツール
Sales HubSales Hub -無料ツール
Service HubService Hub -無料ツール
Content HubContent Hub -Starter
この API には、次のいずれかのスコープが必要です。
crm.objects.carts.write
crm.objects.orders.write
crm.objects.users.write
crm.pipelines.orders.write
crm.schemas.appointments.write
crm.schemas.carts.write
crm.schemas.commercepayments.write
crm.schemas.companies.write
crm.schemas.contacts.write
crm.schemas.courses.write
crm.schemas.deals.write
crm.schemas.invoices.write
crm.schemas.listings.write
crm.schemas.orders.write
crm.schemas.services.write
crm.schemas.subscriptions.write
e-commerce
tickets
tickets.highly_sensitive.v2
tickets.sensitive.v2

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
objectType
string
required
​
pipelineId
string
required

Query Parameters

​
validateReferencesBeforeDelete
boolean
default:false
​
validateDealStageUsagesBeforeDelete
boolean
default:false

Body

application/json

An input used to update some properties on a pipeline definition.

​
archived
boolean

パイプラインがアーカイブされているかどうか。このプロパティーは、アーカイブされたパイプラインを復元する場合にのみ指定します。他の呼び出しで指定されると、リクエストに失敗し、「400 Bad Request」が返されます。

​
displayOrder
integer

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

Response

successful operation

A pipeline definition.

​
createdAt
string<date-time>
required

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

​
archived
boolean
required

パイプラインがアーカイブされているかどうか。

​
displayOrder
integer
required

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

​
stages
object[]
required

パイプラインに関連付けられたステージ。これは、パイプライン ステージ エンドポイントで取得して更新できます。

​
label
string
required

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

​
id
string
required

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

​
updatedAt
string<date-time>
required

パイプラインが最後に更新された日付。

​
archivedAt
string<date-time>

パイプラインがアーカイブされた日付。「archivedAt」はパイプラインがアーカイブされている場合にのみ存在します。