HubSpot: Properties schemas

← Properties operations · All schemas

Archive a batch of properties — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of property names to be processed in the batch operation. Each item in the array is a reference to a PropertyName object.
inputs[]	Model	Each item	Expand Read a batch of properties — request body — body inputs item

Referenced models: Read a batch of properties — request body — body inputs item

Create a batch of properties — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of PropertyCreate objects, each representing a property to be created. This field is required.
inputs[]	Model	Each item	Expand Create a property — request body — body

Referenced models: Create a property — request body — body

Create a property group — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
displayOrder	integer	Optional	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. Format: int32
label	string	Required within parent	A human-readable label that will be shown in HubSpot.
name	string	Required within parent	The internal property group name, which must be used when referencing the property group via the API.

Create a property — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
calculationFormula	string	Optional	Represents a formula that is used to compute a calculated property.
currencyPropertyName	string	Optional	A string representing the name of the currency property.
dataSensitivity	string	Optional	Indicates the sensitivity level of the property, with options: highly_sensitive, non_sensitive, or sensitive. One of: highly_sensitive, non_sensitive, sensitive
description	string	Optional	A description of the property that will be shown as help text in HubSpot.
displayOrder	integer	Optional	Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property to be displayed after any positive values. Format: int32
externalOptions	boolean	Optional	Applicable only for 'enumeration' type properties. Should be set to true in conjunction with a 'referencedObjectType' of 'OWNER'. Otherwise false.
fieldType	string	Required within parent	Controls how the property appears in HubSpot. One of: booleancheckbox, calculation_equation, checkbox, date, file, html, number, phonenumber, radio, select, text, textarea
formField	boolean	Optional	Whether or not the property can be used in a HubSpot form.
groupName	string	Required within parent	The name of the property group the property belongs to.
hasUniqueValue	boolean	Optional	Whether or not the property's value must be unique. Once set, this can't be changed.
hidden	boolean	Optional	If true, the property won't be visible and can't be used in HubSpot.
label	string	Required within parent	A human-readable property label that will be shown in HubSpot.
name	string	Required within parent	The internal property name, which must be used when referencing the property via the API.
numberDisplayHint	string	Optional	A string providing a hint on how to display numbers. Valid values include 'unformatted', 'formatted', 'currency', 'percentage', 'duration', 'probability'. One of: currency, duration, formatted, percentage, probability, unformatted
options	array	Optional	A list of valid options for the property. This field is required for enumerated properties.
options[]	Model	Each item	Expand Create a property — request body — body options item
referencedObjectType	string	Optional	Should be set to 'OWNER' when 'externalOptions' is true, which causes the property to dynamically pull option values from the current HubSpot users.
showCurrencySymbol	boolean	Optional	A boolean indicating whether to show the currency symbol for currency fields.
textDisplayHint	string	Optional	A string providing a hint on how to display text. Valid values include 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', 'postal_code'. One of: domain_name, email, ip_address, multi_line, phone_number, physical_address, postal_code, unformatted_single_line
type	string	Required within parent	The data type of the property. One of: bool, date, datetime, enumeration, number, phone_number, string

Referenced models: Create a property — request body — body options item

Create a property — request body — body options item

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	A description of the option.
displayOrder	integer	Required within parent	Options are shown in order starting with the lowest positive integer value. Values of -1 will cause the option to be displayed after any positive values. Format: int32
hidden	boolean	Required within parent	Hidden options won't be shown in HubSpot.
label	string	Required within parent	A human-readable option label that will be shown in HubSpot.
value	string	Required within parent	The internal value of the option, which must be used when setting the property value through the API.

Read a batch of properties — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Required within parent	Specifies whether the property is archived.
dataSensitivity	string	Required within parent	Indicates the sensitivity level of the data, such as 'non_sensitive', 'sensitive', or 'highly_sensitive'. One of: highly_sensitive, non_sensitive, sensitive
inputs	array	Required within parent	An array of property names to be included in the batch read operation. Each item in the array is a reference to a PropertyName object.
inputs[]	Model	Each item	Expand Read a batch of properties — request body — body inputs item

Referenced models: Read a batch of properties — request body — body inputs item

Read a batch of properties — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root
name	string	Required within parent	The name of the property to read or modify.

Read a batch of properties — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Properties Batch Response Property

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The timestamp indicating when the batch operation was completed. Format: date-time
links	object	Optional	A collection of URLs linking to documentation or resources related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The timestamp indicating when the batch operation was requested. Format: date-time
results	array	Required within parent	An array of Property objects representing the results of the batch operation.
results[]	Model	Each item	Expand Read a property — response body
startedAt	string	Required within parent	The timestamp indicating when the batch operation began processing. Format: date-time
status	string	Required within parent	The current status of the batch operation, with possible values being CANCELED, COMPLETE, PENDING, or PROCESSING. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Read a property — response body

Read a batch of properties — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Properties Batch Response Property With Errors

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of errors encountered during the batch operation, each represented by a StandardError object.
errors[]	Model	Each item	Expand Remove associations — response body — errors item
links	object	Optional	A map of link names to their associated URIs, providing additional information or actions related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of properties that were processed in the batch operation.
results[]	Model	Each item	Expand Read a property — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Remove associations — response body — errors item, Read a property — response body

Read a property group — response body

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Required within parent	Indicates whether the property group is archived.
displayOrder	JSON	Optional
displayOrder (anyOf 1)	integer	Alternative	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. Format: int32
displayOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
label	string	Required within parent	A human-readable label that will be shown in HubSpot.
name	string	Required within parent	The internal property group name, which must be used when referencing the property group via the API.

Read a property — response body

Field	Type	Presence	Description and constraints
$	object	Root	A HubSpot property
archived	boolean	Optional	Whether or not the property is archived.
archivedAt	string	Optional	When the property was archived. Format: date-time
calculated	boolean	Optional	For default properties, true indicates that the property is calculated by a HubSpot process. It has no effect for custom properties.
calculationFormula	string	Optional	Represents a formula that is used to compute a calculated property.
createdAt	string	Optional	The timestamp when the property was created, in ISO 8601 format. Format: date-time
createdUserId	string	Optional	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.
currencyPropertyName	string	Optional	The name of the currency property associated with this property, if applicable.
dataSensitivity	string	Optional	The sensitivity level of the data. Valid values include 'non_sensitive', 'sensitive', and 'highly_sensitive'. Known values: highly_sensitive, non_sensitive, sensitive
dateDisplayHint	string	Optional	Indicates how date values should be displayed, with options such as 'absolute', 'absolute_with_relative', 'time_since', or 'time_until'. Known values: absolute, absolute_with_relative, time_since, time_until
description	string	Required within parent	A description of the property that will be shown as help text in HubSpot.
displayOrder	JSON	Optional
displayOrder (anyOf 1)	integer	Alternative	Properties are shown in order, starting with the lowest positive integer value. Format: int32
displayOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
externalOptions	boolean	Optional	For default properties, true indicates that the options are stored externally to the property settings.
fieldType	string	Required within parent	Controls how the property appears in HubSpot.
formField	boolean	Optional	Whether or not the property can be used in a HubSpot form.
groupName	string	Required within parent	The name of the property group the property belongs to.
hasUniqueValue	boolean	Optional	Whether or not the property's value must be unique. Once set, this can't be changed.
hidden	boolean	Optional	Whether or not the property will be hidden from the HubSpot UI. It's recommended this be set to false for custom properties.
hubspotDefined	boolean	Optional	This will be true for default object properties built into HubSpot.
label	string	Required within parent	A human-readable property label that will be shown in HubSpot.
modificationMetadata	Model	Optional	Expand Read a property — response body — modification Metadata
name	string	Required within parent	The internal property name, which must be used when referencing the property via the API.
numberDisplayHint	string	Optional	A hint for displaying number properties. Valid values include 'unformatted', 'formatted', 'currency', 'percentage', 'duration', and 'probability'. Known values: currency, duration, formatted, percentage, probability, unformatted
options	array	Required within parent	A list of valid options for the property. This field is required for enumerated properties, but will be empty for other property types.
options[]	Model	Each item	Expand Read a property — response body — options item
referencedObjectType	string	Optional	If this property is related to other object(s), they'll be listed here.
sensitiveDataCategories	array	Optional	An array of categories indicating the sensitivity of the data contained in the property.
sensitiveDataCategories[]	string	Each item
showCurrencySymbol	boolean	Optional	Whether or not the property will display the currency symbol set in the account settings.
textDisplayHint	string	Optional	A hint for displaying text properties. Valid values include 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', and 'postal_code'. Known values: domain_name, email, ip_address, multi_line, phone_number, physical_address, postal_code, unformatted_single_line
type	string	Required within parent	The property data type.
updatedAt	string	Optional	The timestamp when the property was last updated, in ISO 8601 format. Format: date-time
updatedUserId	string	Optional	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.

Referenced models: Read a property — response body — options item, Read a property — response body — modification Metadata

Read a property — response body — modification Metadata

Field	Type	Presence	Description and constraints
$	object	Root
archivable	boolean	Required within parent	Specifies whether the property can be archived.
readOnlyDefinition	boolean	Required within parent	Indicates whether the property's definition is read-only and cannot be modified.
readOnlyOptions	boolean	Optional	Indicates whether the property's options are read-only and cannot be modified.
readOnlyValue	boolean	Required within parent	Indicates whether the property's value is read-only and cannot be modified.

Read a property — response body — options item

Field	Type	Presence	Description and constraints
$	object	Root	A HubSpot property option
description	string	Optional	A description of the option.
displayOrder	JSON	Optional
displayOrder (anyOf 1)	integer	Alternative	Options are displayed in order starting with the lowest positive integer value. Values of -1 will cause the option to be displayed after any positive values. Format: int32
displayOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hidden	boolean	Required within parent	Hidden options will not be displayed in HubSpot.
label	string	Required within parent	A human-readable option label that will be shown in HubSpot.
value	string	Required within parent	The internal value of the option, which must be used when setting the property value through the API.

Read all properties — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	An array of Property objects, each representing a specific property associated with the object type. This array contains the details of each property such as name, label, type, and other metadata.
results[]	Model	Each item	Expand Read a property — response body

Referenced models: Read a property — response body

Read all property groups — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	An array of property groups, where each group is represented by a PropertyGroup object.
results[]	Model	Each item	Expand Read a property group — response body

Referenced models: Read a property group — response body

Update a property group — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
displayOrder	integer	Optional	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. Format: int32
label	string	Optional	A human-readable label that will be shown in HubSpot.

Update a property — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
calculationFormula	string	Optional	Represents a formula that is used to compute a calculated property.
currencyPropertyName	string	Optional	A string specifying the name of the property that holds the currency information, applicable when showCurrencySymbol is true.
description	string	Optional	A description of the property that will be shown as help text in HubSpot.
displayOrder	integer	Optional	Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the Property to be displayed after any positive values. Format: int32
fieldType	string	Optional	Controls how the property appears in HubSpot. One of: booleancheckbox, calculation_equation, checkbox, date, file, html, number, phonenumber, radio, select, text, textarea
formField	boolean	Optional	Whether or not the property can be used in a HubSpot form.
groupName	string	Optional	The name of the property group the property belongs to.
hidden	boolean	Optional	If true, the property won't be visible and can't be used in HubSpot.
label	string	Optional	A human-readable property label that will be shown in HubSpot.
numberDisplayHint	string	Optional	A string providing a hint for displaying number values. Valid values include 'unformatted', 'formatted', 'currency', 'percentage', 'duration', and 'probability'. One of: currency, duration, formatted, percentage, probability, unformatted
options	array	Optional	A list of valid options for the property.
options[]	Model	Each item	Expand Create a property — request body — body options item
showCurrencySymbol	boolean	Optional	A boolean indicating whether to display a currency symbol for number fields formatted as currency.
textDisplayHint	string	Optional	A string providing a hint for displaying text values. Valid values include 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', and 'postal_code'. One of: domain_name, email, ip_address, multi_line, phone_number, physical_address, postal_code, unformatted_single_line
type	string	Optional	The data type of the property. One of: bool, date, datetime, enumeration, number, phone_number, string

Referenced models: Create a property — request body — body options item