メインコンテンツへスキップ
POST
/
crm
/
pipelines
/
2026-03
/
{objectType}
/
{pipelineId}
/
stages
パイプラインステージを作成
curl --request POST \
  --url https://api.hubapi.com/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayOrder": 123,
  "label": "<string>",
  "metadata": {},
  "stageId": "<string>"
}
'
{
  "archived": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "displayOrder": 123,
  "id": "<string>",
  "label": "<string>",
  "metadata": {},
  "updatedAt": "2023-11-07T05:31:56Z",
  "writePermissions": "CRM_PERMISSIONS_ENFORCEMENT",
  "archivedAt": "2023-11-07T05:31:56Z"
}

Supported products

承認

Authorization
string
header
必須

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

パスパラメータ

objectType
string
必須
pipelineId
string
必須

ボディ

application/json
displayOrder
integer<int32>
必須

このパイプラインステージを表示する順序。2つのパイプラインステージの「displayOrder」が同じ場合、ラベルのアルファベット順に並べ替えられます。

label
string
必須

HubSpotのUIでパイプラインステージを整理するために使用されるラベル。各パイプラインステージのラベルはそのパイプライン内で固有である必要があります。

metadata
object
必須

どのオブジェクトパイプラインにも存在しないプロパティーが含まれるJSONオブジェクト。

「deals」パイプラインの場合、「probability」フィールドは必須で(「{ "probability": 0.5 }」)、取引がクローズされる可能性を表します。使用可能な値は0.0~1.0(0.1単位)です。

「tickets」パイプラインの場合、「ticketState」フィールドは任意で(「{ "ticketState": "OPEN" }」)、チケットがオープン中のままになっているのか、サポートチームのメンバーによってクローズされたのかを表します。選択可能な値は「OPEN」または「CLOSED」です。

stageId
string

レスポンス

successful operation

archived
boolean
必須

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

createdAt
string<date-time>
必須

パイプラインステージが作成された日付。デフォルトのパイプラインのステージではcreatedAt = 0になります。

displayOrder
integer<int32>
必須

このパイプラインステージを表示する順序。2つのパイプラインステージの「displayOrder」が同じ場合、ラベルのアルファベット順に並べ替えられます。

id
string
必須

HubSpotによって生成される固有ID。パイプラインステージの取得や更新に使用されます。

label
string
必須

HubSpotのUIでパイプラインステージを整理するために使用されるラベル。各パイプラインステージのラベルはそのパイプライン内で固有である必要があります。

metadata
object
必須

どのオブジェクトパイプラインにも存在しないプロパティーが含まれるJSONオブジェクト。

「deals」パイプラインの場合、「probability」フィールドは必須で(「{ "probability": 0.5 }」)、取引がクローズされる可能性を表します。使用可能な値は0.0~1.0(0.1単位)です。

「tickets」パイプラインの場合、「ticketState」フィールドは任意で(「{ "ticketState": "OPEN" }」)、チケットがオープン中のままになっているのか、サポートチームのメンバーによってクローズされたのかを表します。選択可能な値は「OPEN」または「CLOSED」です。

updatedAt
string<date-time>
必須

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

writePermissions
enum<string>
必須

パイプラインステージの書き込みアクセスのレベルを定義します。可能な値は、CRM_PERMISSIONS_ENFORCEMENT、READ_ONLY、またはINTERNAL_ONLYです。

利用可能なオプション:
CRM_PERMISSIONS_ENFORCEMENT,
INTERNAL_ONLY,
READ_ONLY
archivedAt
string<date-time>

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

Last modified on April 14, 2026