HUhubspot
Basic

Update an existing custom event property

Changed on

Update an existing property in a custom event definition.

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

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/events/2026-03/event-definitions/{eventName}/property/{propertyName}
  • Auth
    • HTTP bearer
    • or API key in query parameter hapikey
    • or none

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 or not the property is archived.

archivedAtstring date-time

When the property was archived.

calculatedboolean

For default properties, true indicates that the property is calculated by a HubSpot process. It has no effect for custom properties.

calculationFormulastring

The formula used for calculated properties.

createdAtstring date-time

When the property was created

createdUserIdstring

The internal ID of the user who created the property in HubSpot. This field may not exist if the property was created outside of HubSpot.

currencyPropertyNamestring

The name of the related currency 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'

Controls how date properties are displayed in the HubSpot UI, with options such as 'absolute', 'absolute_with_relative', 'time_since', and 'time_until'.

descriptionstring required

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

displayOrderinteger

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.

externalOptionsboolean

For default properties, true indicates that the options are stored externally to the property settings.

fieldTypestring required

Controls how the property appears in HubSpot.

formFieldboolean

Whether or not the property can be used in a HubSpot form.

groupNamestring required

The name of the property group the property belongs to.

hasUniqueValueboolean

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

hiddenboolean

Hidden options won't be shown in HubSpot.

hubspotDefinedboolean

This will be true for default object properties built into HubSpot.

labelstring required

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

namestring required

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

numberDisplayHint'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'

Hint for how a number property is displayed and validated in HubSpot's UI. Can be: "unformatted", "formatted", "currency", "percentage", "duration", or "probability".

referencedObjectTypestring

If this property is related to other object(s), they'll be listed here.

sensitiveDataCategoriesstring[]

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

showCurrencySymbolboolean

Whether the property will display the currency symbol set in the account settings.

typestring required

The property data type.

updatedAtstring date-time

When the object type was last updated.

updatedUserIdstring

The internal user ID of the user who updated the property in HubSpot. This field may not exist if the property was updated outside of HubSpot.

Changes

Some revisions have not been checked yet.