curl --request PATCH \
--url https://api.hubapi.com/crm/properties/2026-03/{objectType}/{propertyName} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"calculationFormula": "<string>",
"currencyPropertyName": "<string>",
"description": "<string>",
"displayOrder": 123,
"fieldType": "booleancheckbox",
"formField": true,
"groupName": "<string>",
"hidden": true,
"label": "<string>",
"numberDisplayHint": "currency",
"options": [
{
"displayOrder": 123,
"hidden": true,
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
],
"showCurrencySymbol": true,
"type": "bool"
}
'{
"description": "<string>",
"fieldType": "<string>",
"groupName": "<string>",
"label": "<string>",
"name": "<string>",
"options": [
{
"hidden": true,
"label": "<string>",
"value": "<string>",
"description": "<string>",
"displayOrder": 123
}
],
"type": "<string>",
"archived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"calculated": true,
"calculationFormula": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdUserId": "<string>",
"currencyPropertyName": "<string>",
"dataSensitivity": "highly_sensitive",
"dateDisplayHint": "absolute",
"displayOrder": 123,
"externalOptions": true,
"formField": true,
"hasUniqueValue": true,
"hidden": false,
"hubspotDefined": true,
"modificationMetadata": {
"archivable": true,
"readOnlyDefinition": true,
"readOnlyValue": true,
"readOnlyOptions": true
},
"numberDisplayHint": "currency",
"referencedObjectType": "<string>",
"sensitiveDataCategories": [
"<string>"
],
"showCurrencySymbol": true,
"updatedAt": "2023-11-07T05:31:56Z",
"updatedUserId": "<string>"
}によって識別されるプロパティーの一部更新を実行します。指定したフィールドは上書きされます。
curl --request PATCH \
--url https://api.hubapi.com/crm/properties/2026-03/{objectType}/{propertyName} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"calculationFormula": "<string>",
"currencyPropertyName": "<string>",
"description": "<string>",
"displayOrder": 123,
"fieldType": "booleancheckbox",
"formField": true,
"groupName": "<string>",
"hidden": true,
"label": "<string>",
"numberDisplayHint": "currency",
"options": [
{
"displayOrder": 123,
"hidden": true,
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
],
"showCurrencySymbol": true,
"type": "bool"
}
'{
"description": "<string>",
"fieldType": "<string>",
"groupName": "<string>",
"label": "<string>",
"name": "<string>",
"options": [
{
"hidden": true,
"label": "<string>",
"value": "<string>",
"description": "<string>",
"displayOrder": 123
}
],
"type": "<string>",
"archived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"calculated": true,
"calculationFormula": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdUserId": "<string>",
"currencyPropertyName": "<string>",
"dataSensitivity": "highly_sensitive",
"dateDisplayHint": "absolute",
"displayOrder": 123,
"externalOptions": true,
"formField": true,
"hasUniqueValue": true,
"hidden": false,
"hubspotDefined": true,
"modificationMetadata": {
"archivable": true,
"readOnlyDefinition": true,
"readOnlyValue": true,
"readOnlyOptions": true
},
"numberDisplayHint": "currency",
"referencedObjectType": "<string>",
"sensitiveDataCategories": [
"<string>"
],
"showCurrencySymbol": true,
"updatedAt": "2023-11-07T05:31:56Z",
"updatedUserId": "<string>"
}Supported products
Required Scopes
The access token received from the authorization server in the OAuth 2.0 flow.
計算プロパティーの計算に使用される式を表します。
HubSpotにヘルプテキストとして表示されるプロパティーの説明。
プロパティーは、最も小さい正の整数値を先頭に表示されます。「-1」という値にすると、そのプロパティーは全ての正の値よりも後に表示されます。
HubSpotでのプロパティーの表示が制御されます。
booleancheckbox, calculation_equation, checkbox, date, file, html, number, phonenumber, radio, select, text, textarea HubSpotフォームにプロパティーを使用できるかどうか。
プロパティーが含まれているプロパティーグループの名前。
trueの場合、HubSpotにプロパティーは表示されず、使用できません。
HubSpotに表示される、人間が読めるプロパティーラベル。
currency, duration, formatted, percentage, probability, unformatted プロパティーの有効なオプションのリスト。
Show child attributes
プロパティーのデータ型。
bool, date, datetime, enumeration, number, phone_number, string successful operation
HubSpotプロパティー
HubSpotにヘルプテキストとして表示されるプロパティーの説明。
HubSpotでのプロパティーの表示が制御されます。
プロパティーが含まれているプロパティーグループの名前。
HubSpotに表示される、人間が読めるプロパティーラベル。
このAPIを使用してプロパティーを参照する際に使用する必要がある内部プロパティー名。
プロパティーに有効なオプションのリスト。このフィールドは列挙型のプロパティーに必要ですが、他のプロパティータイプでは空になります。
Show child attributes
プロパティーのデータ型。
プロパティーがアーカイブされているかどうか。
プロパティーがアーカイブされた日時
デフォルトのプロパティーの場合、trueはプロパティーがHubSpotプロセスによって計算されることを示します。カスタムプロパティーの場合は効果がありません。
計算プロパティーの計算に使用される式を表します。
プロパティーが作成された時刻のタイムスタンプ(ISO 8601形式)。
HubSpotでプロパティーを作成したユーザーの内部ユーザーID。プロパティーがHubSpot外で作成された場合、このフィールドは存在しない場合があります。
関連する通貨プロパティーの名前。
「non_sensitive」、「sensitive」、「highly_sensitive」など、プロパティーのセンシティブ(慎重に扱うべき)レベルを示します。
highly_sensitive, non_sensitive, sensitive 日付値を表示する方法を示します。「absolute」、「absolute_with_relative」、「time_since」、「time_until」などのオプションがあります。
absolute, absolute_with_relative, time_since, time_until プロパティーは、正の整数値の低い順に表示されます。
デフォルトのプロパティーの場合、trueはオプションがプロパティー設定外に格納されていることを示します。
HubSpotフォームにプロパティーを使用できるかどうか。
プロパティーの値が固有である必要があるかどうか。設定すると、変更はできません。
HubSpot UIでプロパティーが非表示になるかどうか。カスタムプロパティーの場合、これをfalseに設定することをお勧めします。
false
HubSpotに組み込まれているデフォルトのオブジェクトプロパティーではtrueになります。
Show child attributes
HubSpotのUIでの数値プロパティーの表示方法と検証方法に関するヒント。「unformatted」、「formatted」、「currency」、「percentage」、「duration」、「probability」のいずれかにできます。
currency, duration, formatted, percentage, probability, unformatted このプロパティーが他のオブジェクトに関連している場合、ここに一覧で表示されます。
sensitiveDataがtrueの場合、プロパティーに含まれるセンシティブデータのタイプを示します(例:「HIPAA」)。
プロパティーによってアカウント設定で定義された通貨記号が表示されるかどうか。
プロパティーが最後に更新されたタイムスタンプ(ISO 8601形式)。
HubSpotでプロパティーを更新したユーザーの内部ユーザーID。プロパティーがHubSpot外で更新された場合、このフィールドは存在しない場合があります。