CreateCustomObject
Creates a custom object in HubSpot. Requires private-app token authentication if OAuth scopes are insufficient.
Input
| Name | Type | Description |
| ObjectName | String | Unique identifier for the custom object type within the schema. This name must be unique and is used when referencing the object in the API. |
| ObjectLabelSingular | String | The singular form of the custom object's label, shown in the CRM interface to represent a single instance of the object. |
| ObjectLabelPlural | String | The plural form of the custom object's label, shown in the CRM interface to represent multiple instances of the object. |
| PropertyName# | String | The internal name of the property. This is used in API requests and must remain consistent for integrations and automation. |
| PropertyLabel# | String | The display label for the property as shown in HubSpot's UI. It should be easily understandable to end users. |
| PropertyGroupName# | String | Optional grouping label for organizing related properties in the HubSpot UI under a shared section. |
| PropertyDescription# | String | Optional help text that appears in the HubSpot UI to guide users on how to fill out the property. |
| PropertyOptionsLabel# | String | Comma-separated list of user-facing labels for property options when the field type is an enumeration. These labels appear in dropdowns or selection fields. |
| PropertyOptionsValue# | String | Comma-separated list of backend values corresponding to the labels for enumerated properties. These are used in API requests when setting property values. |
| PropertyOptionsDescription# | String | Optional comma-separated list of descriptions for each property option, shown as tooltips or help text in the HubSpot interface. |
| PropertyOptionsDisplayOrder# | String | Optional comma-separated list defining the display order of property options. Use -1 to display an option after all others with positive values. |
| PropertyOptionsHidden# | String | Optional comma-separated list indicating whether each property option should be hidden from users in the HubSpot interface. |
| PropertyDisplayOrder# | String | Defines the order in which this property appears in the UI relative to others. Lower numbers appear first; -1 positions the property after all others. |
| PropertyHasUniqueValue# | String | Specifies whether the property value must be unique across all object records. Once enabled, this setting cannot be changed. |
| PropertyHidden# | String | Specifies whether the property is hidden from the HubSpot user interface, preventing users from seeing or editing it directly. |
| PropertyType# | String | Defines the data type of the property. Accepted types include string, number, date, enumeration, and datetime. |
| PropertyFieldType# | String | Determines how the property is rendered in the HubSpot interface, such as text input, date picker, dropdown, or checkbox. Must be compatible with the specified PropertyType. |
| RequiredProperty# | String | List of properties that must be populated when creating an instance of this custom object. |
| SearchableProperty# | String | List of properties that will be indexed by HubSpot and included in CRM-wide search functionality. |
| PrimaryDisplayProperty | String | Name of the main property shown as the object's primary identifier in HubSpot records. |
| SecondaryDisplayProperty# | String | Names of additional properties displayed as secondary information under the primary property on the object record page. |
| AssociatedObject# | String | Defines which other standard or custom objects can be associated with this custom object type. |
Result Set Columns
| Name | Type | Description |
| Success | String | Returns True if the custom object was successfully created through the procedure. |
| ObjectName | String | Name of the custom object that was created, used for API and internal reference. |
| ObjectLabel | String | Plural label of the created custom object, used for display in the HubSpot interface. |
| ErrorCode | String | Numeric or symbolic code indicating the reason the procedure failed, if applicable. |
| ErrorMessage | String | Detailed message describing the error that occurred during the creation of the custom object. |