CreateCustomProperty
Create a Custom Property for a HubSpot Object.
Input
Name | Type | Description |
ObjectFullyQualifiedName | String | The fully qualified name of the object to create the property. Required if the TableName attribute is not specified. |
TableName | String | The exposed table name of the object to create the property. Required if the FullyQualifiedName attribute is not specified. |
PropertyName | String | Required attribute. The internal property name, which must be used when referencing the property from the API. |
PropertyLabel | String | Required attribute. A human-readable property label that will be shown in HubSpot. |
PropertyGroupName | String | Required attribute. The name of the group this property belongs to. |
PropertyType | String | Required attribute. The data type of the property. Supported values are: string, number, date, enumeration, datetime. |
PropertyFieldType | String | Required attribute. Controls how the property appears in HubSpot. Supported values are: textarea, text, date, file, number, select, radio, checkbox, booleancheckbox. The set GUI display option must support the specified PropertyType. |
PropertyDescription | String | Optional attribute. A description of the property that will be shown as help text in HubSpot. |
PropertyOptionsLabel# | String | Required only if PropertyFieldType is set to enumeration. A human-readable option label that will be shown in HubSpot. |
PropertyOptionsValue# | String | Required only if PropertyFieldType is set to enumeration. The internal value of the option, which must be used when setting the property value through the API. |
PropertyOptionsDescription# | String | Optional attribute. A description of the option. |
PropertyOptionsDisplayOrder# | String | Optional attribute. 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. |
PropertyOptionsHidden# | String | Optional attribute. Hidden options won't be shown in HubSpot. |
PropertyDisplayOrder | String | Optional attribute. The order that this property should be displayed in the HubSpot UI relative to other properties for this object type. Properties are displayed in order starting with the lowest positive integer value. A value of -1 will cause the property to be displayed after any positive values. |
PropertyHasUniqueValue | String | Optional attribute. Whether or not the property's value must be unique. Once set, this can't be changed. |
PropertyHidden | String | Optional attribute. Whether or not the property is hidden from the GUI. |
FormField | String | Optional attribute. Whether or not the property can be used in a HubSpot form. |
ObjectType | String | Optional attribute. The object type. |
Result Set Columns
Name | Type | Description |
Success | String | Returns True if the property is successfully created. |
PropertyName | String | Name of the newly created property. |
PropertyLabel | String | Plural label of the newly created property. |