メインコンテンツへスキップ
PATCH
/
crm
/
v3
/
properties
/
{objectType}
/
{propertyName}
プロパティーを更新
curl --request PATCH \
  --url https://api.hubapi.com/crm/v3/properties/{objectType}/{propertyName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayOrder": 2,
  "fieldType": "select",
  "formField": true,
  "groupName": "contactinformation",
  "hidden": false,
  "label": "My Contact Property",
  "name": "my_contact_property",
  "options": [
    {
      "description": "Choice number one",
      "displayOrder": 1,
      "hidden": false,
      "label": "Option A",
      "value": "A"
    },
    {
      "description": "Choice number two",
      "displayOrder": 2,
      "hidden": false,
      "label": "Option B",
      "value": "B"
    }
  ],
  "type": "enumeration"
}
'
{
  "displayOrder": 2,
  "fieldType": "select",
  "formField": true,
  "groupName": "contactinformation",
  "hasUniqueValue": false,
  "hidden": false,
  "label": "My Contact Property",
  "modificationMetadata": {
    "archivable": true,
    "readOnlyDefinition": false,
    "readOnlyOptions": false,
    "readOnlyValue": false
  },
  "name": "my_contact_property",
  "options": [
    {
      "description": "Choice number one",
      "displayOrder": 1,
      "hidden": false,
      "label": "Option A",
      "value": "A"
    },
    {
      "description": "Choice number two",
      "displayOrder": 2,
      "hidden": false,
      "label": "Option B",
      "value": "B"
    }
  ],
  "type": "enumeration"
}

サポートされる製品

次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub -無料ツール
Sales HubSales Hub -無料ツール
Service HubService Hub -無料ツール
Content HubContent Hub -無料ツール

承認

​
Authorization
string
header
必須

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

パスパラメータ

​
objectType
string
必須

プロパティーが属するオブジェクトのタイプ。

​
propertyName
string
必須

更新するプロパティーの名前。

ボディ

application/json
​
calculationFormula
string

計算プロパティーの計算に使用される式を表します。

​
description
string

HubSpotにヘルプテキストとして表示されるプロパティーの説明。

​
displayOrder
integer<int32>

プロパティーグループは、最も小さい正の整数値を先頭に表示されます。「-1」という値にすると、そのプロパティーグループは全ての正の値よりも後に表示されます。

​
fieldType
enum<string>

HubSpotでのプロパティーの表示が制御されます。

利用可能なオプション:
booleancheckbox,
calculation_equation,
checkbox,
date,
file,
html,
number,
phonenumber,
radio,
select,
text,
textarea
​
formField
boolean

HubSpotフォームにプロパティーを使用できるかどうか。

​
groupName
string

プロパティーが含まれているプロパティーグループの名前。

​
hidden
boolean

trueの場合、HubSpotにプロパティーは表示されず、使用できません。

​
label
string

HubSpotに表示される、人間が読めるラベル。

​
options
object[]

プロパティーの有効なオプションのリスト。このフィールドは列挙型のプロパティーに必要です。

​
type
enum<string>

プロパティーのデータ型。

利用可能なオプション:
bool,
date,
datetime,
enumeration,
number,
phone_number,
string

レスポンス

successful operation

HubSpotプロパティー

​
description
string
必須

HubSpotにヘルプテキストとして表示されるプロパティーの説明。

​
fieldType
string
必須

HubSpotでのプロパティーの表示が制御されます。

​
groupName
string
必須

プロパティーが含まれているプロパティーグループの名前。

​
label
string
必須

HubSpotに表示される、人間が読めるラベル。

​
name
string
必須

読み取りまたは変更を行うプロパティーの名前。

​
options
object[]
必須

プロパティーの有効なオプションのリスト。このフィールドは列挙型のプロパティーに必要です。

​
type
string
必須

プロパティーのデータ型。

​
archived
boolean

プロパティーがアーカイブされているかどうか。

​
archivedAt
string<date-time>

プロパティーがアーカイブされた日時

​
calculated
boolean

デフォルトのプロパティーの場合、trueはプロパティーがHubSpotプロセスによって計算されることを示します。カスタムプロパティーの場合は効果がありません。

​
calculationFormula
string

計算プロパティーの計算に使用される式を表します。

​
createdAt
string<date-time>

プロパティーが作成された時刻のタイムスタンプ（ISO 8601形式）。

​
createdUserId
string

HubSpotでプロパティーを作成したユーザーの内部ユーザーID。プロパティーがHubSpot外で作成された場合、このフィールドは存在しない場合があります。

​
dataSensitivity
enum<string>

「non_sensitive」、「sensitive」、「highly_sensitive」など、プロパティーのセンシティブ（慎重に扱うべき）レベルを示します。

利用可能なオプション:
highly_sensitive,
non_sensitive,
sensitive
​
dateDisplayHint
enum<string>

日付値を表示する方法を示します。「absolute」、「absolute_with_relative」、「time_since」、「time_until」などのオプションがあります。

利用可能なオプション:
absolute,
absolute_with_relative,
time_since,
time_until
​
displayOrder
integer<int32>

プロパティーグループは、最も小さい正の整数値を先頭に表示されます。「-1」という値にすると、そのプロパティーグループは全ての正の値よりも後に表示されます。

​
externalOptions
boolean

「列挙」タイプのプロパティーにのみ適用されます。「referencedObjectType」が「OWNER」の場合はtrueに設定する必要があります。それ以外の場合はfalseに設定します。

​
formField
boolean

HubSpotフォームにプロパティーを使用できるかどうか。

​
hasUniqueValue
boolean

プロパティーの値が固有である必要があるかどうか。設定すると、変更はできません。

​
hidden
boolean

trueの場合、HubSpotにプロパティーは表示されず、使用できません。

例:

false

​
hubspotDefined
boolean

HubSpotに組み込まれているデフォルトのオブジェクトプロパティーではtrueになります。

​
modificationMetadata
object
​
referencedObjectType
string

「externalOptions」がtrueの場合、「OWNER」に設定する必要があります。これにより、現在のHubSpotユーザーのオプション値が動的にプロパティーに取り込まれます。

​
sensitiveDataCategories
string[]

sensitiveDataがtrueの場合、プロパティーに含まれるセンシティブデータのタイプを示します（例：「HIPAA」）。

​
showCurrencySymbol
boolean

プロパティーによってアカウント設定で定義された通貨記号が表示されるかどうか。

​
updatedAt
string<date-time>

プロパティーが最後に更新されたタイムスタンプ（ISO 8601形式）。

​
updatedUserId
string

HubSpotでプロパティーを更新したユーザーの内部ユーザーID。プロパティーがHubSpot外で更新された場合、このフィールドは存在しない場合があります。

Last modified on March 5, 2026