Account & Settings
アプリ管理
自動化
CMS
Communication preferences
コミュニケーション
CRM
ファイル
マーケティング
レポート
Scheduler
curl --request PUT \
--url https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayOrder": 123,
"label": "<string>",
"metadata": {}
}
'{
"archived": false,
"createdAt": "2019-10-30T03:30:17.883Z",
"displayOrder": 0,
"id": "1234912",
"label": "In Progress",
"metadata": {
"ticketState": "OPEN"
},
"updatedAt": "2019-12-07T16:50:06.678Z"
}Replace a pipeline stage
既存のパイプラインステージの全てのプロパティーを指定された値で置換します。更新されたステージはレスポンスで返されます。
curl --request PUT \
--url https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayOrder": 123,
"label": "<string>",
"metadata": {}
}
'{
"archived": false,
"createdAt": "2019-10-30T03:30:17.883Z",
"displayOrder": 0,
"id": "1234912",
"label": "In Progress",
"metadata": {
"ticketState": "OPEN"
},
"updatedAt": "2019-12-07T16:50:06.678Z"
}Supported products
Supported products
Required Scopes
Required Scopes
承認
The access token received from the authorization server in the OAuth 2.0 flow.
ボディ
このパイプラインステージを表示する順序。2つのパイプラインステージの「displayOrder」が同じ場合、ラベルのアルファベット順に並べ替えられます。
HubSpotのUIでパイプラインステージを整理するために使用されるラベル。各パイプラインステージのラベルはそのパイプライン内で固有である必要があります。
どのオブジェクトパイプラインにも存在しないプロパティーが含まれるJSONオブジェクト。
「deals」パイプラインの場合、「probability」フィールドは必須で（「{ "probability": 0.5 }」）、取引がクローズされる可能性を表します。使用可能な値は0.0～1.0（0.1単位）です。
「tickets」パイプラインの場合、「ticketState」フィールドは任意で（「{ "ticketState": "OPEN" }」）、チケットがオープン中のままになっているのか、サポートチームのメンバーによってクローズされたのかを表します。選択可能な値は「OPEN」または「CLOSED」です。
Show child attributes
Show child attributes
レスポンス
successful operation
A pipeline stage definition.
パイプラインがアーカイブされているかどうか。
パイプラインステージが作成された日付。デフォルトのパイプラインのステージではcreatedAt = 0になります。
このパイプラインステージを表示する順序。2つのパイプラインステージの「displayOrder」が同じ場合、ラベルのアルファベット順に並べ替えられます。
HubSpotによって生成される固有ID。パイプラインステージの取得や更新に使用されます。
HubSpotのUIでパイプラインステージを整理するために使用されるラベル。各パイプラインステージのラベルはそのパイプライン内で固有である必要があります。
どのオブジェクトパイプラインにも存在しないプロパティーが含まれるJSONオブジェクト。
「deals」パイプラインの場合、「probability」フィールドは必須で（「{ "probability": 0.5 }」）、取引がクローズされる可能性を表します。使用可能な値は0.0～1.0（0.1単位）です。
「tickets」パイプラインの場合、「ticketState」フィールドは任意で（「{ "ticketState": "OPEN" }」）、チケットがオープン中のままになっているのか、サポートチームのメンバーによってクローズされたのかを表します。選択可能な値は「OPEN」または「CLOSED」です。
Show child attributes
Show child attributes
パイプラインステージが最後に更新された日付。
パイプラインがアーカイブされた日付。「archivedAt」はパイプラインがアーカイブされている場合にのみ存在します。
パイプラインステージの書き込みアクセスのレベルを定義します。可能な値は、CRM_PERMISSIONS_ENFORCEMENT、READ_ONLY、またはINTERNAL_ONLYです。
CRM_PERMISSIONS_ENFORCEMENT, INTERNAL_ONLY, READ_ONLY