メインコンテンツへスキップ
POST
プロパティを作成

Supported products

承認

Authorization
string
header
必須

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

パスパラメータ

eventName
string
必須

プロパティーが作成されるイベント定義の固有ID。

ボディ

application/json
label
string
必須

プロパティーの表示名を表す文字列です。このフィールドは必須です。

type
string
必須

プロパティーのデータ型を示す文字列です。このフィールドは必須です。

description
string

プロパティーに関する追加情報を提供する文字列。

name
string

プロパティーの一意の名前を表す文字列。

options
object[]

プロパティーの可能な値を定義するOptionInputオブジェクトの配列。

レスポンス

successful operation

A HubSpot property

description
string
必須

プロパティーの説明。

fieldType
string
必須

プロパティーのフィールドタイプ。

groupName
string
必須

このプロパティーが属するグループの名前。

label
string
必須

プロパティーの表示ラベル。

name
string
必須

プロパティの一意の名前。

options
object[]
必須

このプロパティーで利用可能なオプションの配列。プロパティーが複数の値をサポートする場合に適用されます。

type
string
必須

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

archived
boolean

プロパティーがアーカイブ済みかどうかを示します。

archivedAt
string<date-time>

このプロパティーがアーカイブされた日時(ISO 8601形式)

calculated
boolean

プロパティーが計算済みであるかどうかを示します。

calculationFormula
string

該当する場合、プロパティーの値の計算に使用される数式。

createdAt
string<date-time>

このプロパティーが作成された日時(ISO 8601形式)。

createdUserId
string

このプロパティーを作成したユーザーのID。

currencyPropertyName
string

このプロパティーに関連付けられている通貨プロパティーの名前。

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>

このプロパティーの他のプロパティーに対する相対的な表示順序。

externalOptions
boolean

プロパティーのオプションが外部であるかどうかを示します。

formField
boolean

プロパティーがフォームフィールドであるかどうかを示します。

hasUniqueValue
boolean

プロパティーに一意の値があるかどうかを示します。

hidden
boolean

プロパティーが非表示かどうかを示します。

例:

false

hubspotDefined
boolean

プロパティーがHubSpotによって定義されているかどうかを示します。

modificationMetadata
object
numberDisplayHint
enum<string>

数値プロパティーの表示方法に関するヒント。有効な値は「unformatted」、「formatted」、「currency」、「percentage」、「duration」、 「probability」などです。

利用可能なオプション:
currency,
duration,
formatted,
percentage,
probability,
unformatted
referencedObjectType
string

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

sensitiveDataCategories
string[]

データの機密性を示すカテゴリの配列。

showCurrencySymbol
boolean

プロパティーに通貨記号を表示するかどうかを示します。

textDisplayHint
enum<string>

テキストプロパティーの表示に関するヒント。有効な値には、「unformatted_single_line」、「multi_line」、「email」、「phone_number」、「domain_name」、「ip_address」、「physical_address」、「postal_code」があります。

利用可能なオプション:
domain_name,
email,
ip_address,
multi_line,
phone_number,
physical_address,
postal_code,
unformatted_single_line
updatedAt
string<date-time>

このプロパティーが最後に更新された日時(ISO 8601形式)。

updatedUserId
string

このプロパティーを最後に更新したユーザーのID。

最終更新日 2026年10月6日