Defines a property to create.

Constructors

Properties

description?: string

A description of the property that will be shown as help text in HubSpot.

displayOrder?: number

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.

fieldType: string

Controls how the property appears in HubSpot.

formField?: boolean

Whether the property can be used in a HubSpot form.

groupName?: string

The name of the group this property belongs to.

hasUniqueValue?: boolean

Whether or not the property's value must be unique. Once set, this can't be changed.

hidden?: boolean
label: string

A human-readable property label that will be shown in HubSpot.

name: string

The internal property name, which must be used when referencing the property from the API.

Controls how numeric properties are formatted in the HubSpot UI

options?: OptionInput[]

A list of available options for the property. This field is only required for enumerated properties.

Controls how the property options will be sorted in the HubSpot UI.

referencedObjectType?: string

Defines the options this property will return, e.g. OWNER would return name of users on the portal.

searchableInGlobalSearch?: boolean

Allow users to search for information entered to this field (limited to 3 properties)

showCurrencySymbol?: boolean

Whether the property will display the currency symbol in the HubSpot UI.

Controls how text properties are formatted in the HubSpot UI

The data type of the property.

attributeTypeMap: {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[] = ...
discriminator: undefined | string = undefined

Methods

  • Returns {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]