Cmdlets for HubSpot

Build 24.0.9032

DealProperties

Deal properties are the standard and custom pieces of field data that appear in HubSpot.

Table Specific Information

Deal properties are a number of custom properties that are available to store data about the deals in your HubSpot Hub. Some of these properties are added by HubSpot and cannot be deleted. They will be automatically added to the Deals on a new connection.

SELECT

Deal properties can only be filtered by the unique deal property name. For example:

SELECT * FROM DealProperties WHERE Name = 'property_name'

Columns

Name Type ReadOnly References Description
Name [KEY] String False

The name of the contact property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.

Label String False

The human readable label for the contact property that will display in the HubSpot UI.

FieldType String False

The type of field that will display on the screen for the company property.

使用できる値は次のとおりです。textarea, select, text, date, file, number, radio, checkbox, booleancheckbox

Type String False

The stored machine type for the company property.

使用できる値は次のとおりです。string, number, bool, datetime, enumeration

GroupName String False

DealPropertyGroups.Name

The group the company property is a part of.

Description String False

A description of what the property is for.

DisplayMode String False

How the property will be displayed.

DisplayOrder Integer False

The order in which the property should be displayed in relation to other properties in the same group.

ExternalOptions Boolean False

Boolean indicating if there are external options associate with the company property.

IsFormField Boolean False

Boolean indicating if the property is a field that is part of a form.

IsCalculated Boolean False

Boolean indicating if the property is calculated.

IsHidden Boolean False

Boolean indicating if the property is hidden.

IsDeleted Boolean True

Boolean indicating if the property has been deleted.

IsHubspotDefined Boolean True

Boolean indicating if the property is defined by HubSpot.

ShowCurrencySymbol Boolean False

Boolean indicating if the currency symbol should be shown. Only applicable for numbers.

MutableDefinitionNotDeletable Boolean False

Boolean indicating if the property can be modified but not deleted.

ReadOnlyDefinition Boolean False

Boolean indicating if the definition for the property is read only.

ReadOnlyValue Boolean False

Boolean indicating if the value of the property is read only.

OptionsUpdatable Boolean False

Boolean indicating if the options can be modified.

OptionsAggregate String False

An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.

ExtraUrlParameters String True

An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9032