ProductProperties
Provides all properties for product records, supporting product data management and enrichment.
Columns
| Name | Type | ReadOnly | References | Description |
| Name [KEY] | String | False |
The unique identifier of the product property. Must use only lowercase letters and numbers, beginning with a lowercase letter. | |
| Label | String | False |
The user-friendly label displayed in HubSpot's interface for the product property. | |
| FieldType | String | False |
Specifies the input field type (such as text, dropdown, checkbox) used to display the product property in forms or UI. The allowed values are textarea, select, text, date, file, number, radio, checkbox. | |
| Type | String | False |
The backend data type used to store the product property (such as string, number, boolean). The allowed values are string, number, bool, datetime, enumeration. | |
| GroupName | String | False |
The property group to which this product property belongs, used for organizational purposes. | |
| Description | String | False |
A brief explanation describing the purpose and usage of the product property. | |
| DisplayMode | String | False |
Defines how the product property appears visually in the interface, such as editable, read-only, or hidden. | |
| DisplayOrder | Integer | False |
Determines the display order of the product property relative to others in the same group. | |
| ExternalOptions | Boolean | False |
Boolean indicating whether the product property uses externally managed options (such as linked dropdown values). | |
| IsFormField | Boolean | False |
Specifies whether the product property is used as an input field in forms. | |
| IsCalculated | Boolean | False |
Indicates whether the product property is a calculated field, automatically derived from other property values. | |
| IsHidden | Boolean | False |
Boolean indicating whether the product property is hidden from the user interface. | |
| IsFavorited | Boolean | False |
Marks whether the product property is favorited and given priority in the display. | |
| FavoritedOrder | Integer | False |
Specifies the order of favorited product properties when multiple properties are marked as favorited. | |
| MutableDefinitionNotDeletable | Boolean | False |
Indicates whether the product property definition can be edited but cannot be deleted. | |
| ReadOnlyDefinition | Boolean | False |
Boolean specifying whether the definition (structure) of the product property is read-only and cannot be changed. | |
| ReadOnlyValue | Boolean | False |
Boolean specifying whether the value of the product property is read-only and cannot be modified. | |
| OptionsAggregate | String | False |
A comma-separated list of selectable options available for properties of field types like radio buttons, checkboxes, or dropdowns. | |
| ExtraUrlParameters | String | True |
An input-only parameter for specifying additional query parameters when retrieving data. Use a comma-separated list of name=value pairs, for example: 'param1=value1, param2=value2, param3=value3'. |