UpdateCustomProperty
Update an existing Custom Property for a HubSpot Object.
Input
Name | Type | Description |
ObjectFullyQualifiedName | String | The fully qualified name of the object containing the property to update. Required if the TableName attribute is not specified. |
TableName | String | The exposed table name of the object containing the property to update. Required if the FullyQualifiedName attribute is not specified. |
PropertyName | String | The internal name of the property to update. Required if the ColumnName attribute is not specified. |
ColumnName | String | The exposed column name of the property to update. Required if the PropertyName attribute is not specified. |
PropertyLabel | String | A human-readable property label that will be shown in HubSpot. |
PropertyGroupName | String | The name of the group this property belongs to. |
PropertyDescription | String | A description of the property that will be shown as help text in HubSpot. |
PropertyOptionsLabel# | String | A human-readable option label that will be shown in HubSpot. |
PropertyOptionsValue# | String | The internal value of the option, which must be used when setting the property value through the API. |
PropertyOptionsDescription# | String | A description of the option. |
PropertyOptionsDisplayOrder# | String | 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 | Hidden options won't be shown in HubSpot. |
PropertyDisplayOrder | String | 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 | Whether or not the property's value must be unique. Once set, this can't be changed. |
PropertyHidden | String | Whether or not the property is hidden from the GUI. |
PropertyType | String | The data type of the property. Supported values are: string, number, date, enumeration, datetime. |
PropertyFieldType | String | 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. |
FormField | String | Whether or not the property can be used in a HubSpot form. |
Result Set Columns
Name | Type | Description |
Success | String | Returns True if the property is successfully updated. |
PropertyName | String | Name of the newly updated property. |
PropertyLabel | String | Plural label of the newly updated property. |