Basic

Update property

Update a specific property of a behavioral event definition in your HubSpot account. This operation allows you to modify the details of an existing property associated with a given event. Use this endpoint to keep your event properties up-to-date with the latest information.

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

Request

Base URL
https://api.hubapi.com
URL
https://api.hubapi.com/events/2026-09/event-definitions/{eventName}/property/{propertyName}
Auth
OAuth 2
Authorization code: https://app.hubspot.com/oauth/authorize
Token URL: https://api.hubapi.com/oauth/v1/token scopes: behavioral_events.event_definitions.read_write

Path parameters

eventNamestring required

The unique identifier of the event whose property you want to update.

propertyNamestring required

The name of the property to be updated within the specified event.

Request body

descriptionstring

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

displayOrderinteger

For not hidden properties, indicates the order to display the property on the record's activity timeline (ex: displayOrder: 0 is at the top).

hiddenboolean

Controls whether or not this property is displayed on the record's activity timeline.

labelstring

Human readable label for the property. Used in HubSpot UI.

Response

successful operation

archivedboolean

Indicates whether the property is archived.

archivedAtstring date-time

The date and time when this property was archived, in ISO 8601 format.

calculatedboolean

Indicates whether the property is calculated.

calculationFormulastring

The formula used to calculate the property's value, if applicable.

createdAtstring date-time

The date and time when this property was created, in ISO 8601 format.

createdUserIdstring

The ID of the user who created this property.

currencyPropertyNamestring

The name of the currency property associated with this property.

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

The sensitivity level of the data, with valid values including 'non_sensitive', 'sensitive', and 'highly_sensitive'.

dateDisplayHint'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'

A hint for displaying date properties, with valid values including 'absolute', 'absolute_with_relative', 'time_since', and 'time_until'.

descriptionstring required

A description of the property.

displayOrderinteger

The order in which this property is displayed relative to other properties.

externalOptionsboolean

Indicates whether the property options are external.

fieldTypestring required

The field type of the property.

formFieldboolean

Indicates whether the property is a form field.

groupNamestring required

The name of the group to which this property belongs.

hasUniqueValueboolean

Indicates whether the property has a unique value.

hiddenboolean

Indicates whether the property is hidden.

hubspotDefinedboolean

Indicates whether the property is defined by HubSpot.

labelstring required

The display label for the property.

namestring required

The unique name of the property.

A hint for displaying number properties, with valid values including 'unformatted', 'formatted', 'currency', 'percentage', 'duration', and 'probability'.

referencedObjectTypestring

The type of object that this property references.

sensitiveDataCategoriesstring[]

An array of categories indicating the sensitivity of the data.

showCurrencySymbolboolean

Indicates whether a currency symbol is shown for the property.

A hint for displaying text properties, with valid values including 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', and 'postal_code'.

typestring required

The data type of the property.

updatedAtstring date-time

The date and time when this property was last updated, in ISO 8601 format.

updatedUserIdstring

The ID of the user who last updated this property.

Changes

No recorded changes to this operation across all 3 revisions of this API.