Sign in

v4

latestOpenAPI 3.0.12026-07-131067110.7 KB
Basic

patch/events/custom/2026-09/event-definitions/{eventName}/property/{propertyName}

Path parameters

eventNamestring required
propertyNamestring required

Request body

descriptionstring

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

labelstring

Human readable label for the property. Used in HubSpot UI

Response

successful operation

archivedboolean

Whether the property is archived.

archivedAtstring date-time

The timestamp when the property was archived, in ISO 8601 format.

calculatedboolean

Whether the property is a calculated field.

calculationFormulastring

The formula used for calculated properties.

createdAtstring date-time

The timestamp when the property was created, in ISO 8601 format.

createdUserIdstring

The ID of the user who created the property.

dataSensitivity'highly_sensitive' | 'non_sensitive' | 'sensitive'

Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive".

dateDisplayHint'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'
descriptionstring required

A summary of the property's purpose.

displayOrderinteger

The position of the item relative to others in the list.

externalOptionsboolean

Applicable only for enumeration type properties. Should be set to true with a 'referencedObjectType' of 'OWNER'. Otherwise false.

fieldTypestring required

Determines how the property will appear in HubSpot's UI or on a form. Learn more in the properties API guide.

formFieldboolean

Whether the property can appear on forms.

groupNamestring required

The name of the group to which the property is assigned.

hasUniqueValueboolean

Whether the property is a unique identifier property.

hiddenboolean

Whether or not the property will be hidden from the HubSpot UI. It's recommended that this be set to false for custom properties.

hubspotDefinedboolean

A boolean value set to true for HubSpot default properties.

labelstring required

The display label for the property.

namestring required

The internal name for the property.

referencedObjectTypestring

Deprecated. Use externalOptionsReferenceType instead.

sensitiveDataCategoriesstring[]

When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA").

showCurrencySymbolboolean

Whether to show the currency symbol in HubSpot's UI.

typestring required

The data type of the property, such as string or number.

updatedAtstring date-time

The timestamp when the property was last updated, in ISO 8601 format.

updatedUserIdstring