プロパティーを作成
Create and return a copy of a new property for the specified object type.
サポートされる製品
サポートされる製品
Marketing Hub -無料ツール
Sales Hub -無料ツール
Service Hub -無料ツール
Content Hub -無料ツール必須スコープ
必須スコープ
承認
The access token received from the authorization server in the OAuth 2.0 flow.
パスパラメータ
ボディ
Controls how the property appears in HubSpot.
booleancheckbox, calculation_equation, checkbox, date, file, html, number, phonenumber, radio, select, text, textarea The name of the property group the property belongs to.
A human-readable label that will be shown in HubSpot.
The name of the property to read or modify.
The data type of the property.
bool, date, datetime, enumeration, number, phone_number, string Represents a formula that is used to compute a calculated property.
highly_sensitive, non_sensitive, sensitive A description of the property that will be shown as help text in HubSpot.
Property groups are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property group to be displayed after any positive values.
Applicable only for 'enumeration' type properties. Should be set to true in conjunction with a 'referencedObjectType' of 'OWNER'. Otherwise false.
Whether or not the property can be used in a HubSpot form.
Whether or not the property's value must be unique. Once set, this can't be changed.
If true, the property won't be visible and can't be used in HubSpot.
A list of valid options for the property. This field is required for enumerated properties.
Should be set to 'OWNER' when 'externalOptions' is true, which causes the property to dynamically pull option values from the current HubSpot users.
レスポンス
successful operation
A HubSpot property
A description of the property that will be shown as help text in HubSpot.
Controls how the property appears in HubSpot.
The name of the property group the property belongs to.
A human-readable label that will be shown in HubSpot.
The name of the property to read or modify.
A list of valid options for the property. This field is required for enumerated properties.
The data type of the property.
Whether or not the property is archived.
When the property was archived.
For default properties, true indicates that the property is calculated by a HubSpot process. It has no effect for custom properties.
Represents a formula that is used to compute a calculated property.
The timestamp when the property was created, in ISO 8601 format.
The internal user ID of the user who created the property in HubSpot. This field may not exist if the property was created outside of HubSpot.
Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive".
highly_sensitive, non_sensitive, sensitive absolute, absolute_with_relative, time_since, time_until Property groups are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property group to be displayed after any positive values.
Applicable only for 'enumeration' type properties. Should be set to true in conjunction with a 'referencedObjectType' of 'OWNER'. Otherwise false.
Whether or not the property can be used in a HubSpot form.
Whether or not the property's value must be unique. Once set, this can't be changed.
If true, the property won't be visible and can't be used in HubSpot.
This will be true for default object properties built into HubSpot.
Should be set to 'OWNER' when 'externalOptions' is true, which causes the property to dynamically pull option values from the current HubSpot users.
When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA").
Whether or not the property will display the currency symbol set in the account settings.
The timestamp when the property was last updated, in ISO 8601 format.
The internal user ID of the user who updated the property in HubSpot. This field may not exist if the property was updated outside of HubSpot.