---
title: "Update property"
method: PATCH
path: "/events/2026-09/event-definitions/{eventName}/property/{propertyName}"
tags: ["Basic"]
---

# Update property

`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`

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.

## Path parameters

- `eventName` string, required
- `propertyName` string, required

## Request body

- ExternalBehavioralEventPropertyDefinitionPatch
  - `description` string: A description of the property that will be shown as help text in HubSpot.
  - `displayOrder` integer: For not hidden properties, indicates the order to display the property on the record's activity timeline (ex: displayOrder: 0 is at the top).
  - `hidden` boolean: Controls whether or not this property is displayed on the record's activity timeline.
  - `label` string: Human readable label for the property. Used in HubSpot UI.
  - `options` OptionInput[]: A list of available options for the property if it is an enumeration. NOTE: This field is only applicable for enumerated properties.
    - `description` string: A string providing additional information about the option.
    - `displayOrder` integer, required: An integer indicating the order in which the option should be displayed relative to other options.
    - `hidden` boolean, required: A boolean indicating whether the option is hidden from view.
    - `label` string, required: A string representing the display label for the option.
    - `value` string, required: A string representing the unique value associated with the option.

## Response `201`

successful operation

- Property: A HubSpot property
  - `archived` boolean: Indicates whether the property is archived.
  - `archivedAt` string, date-time: The date and time when this property was archived, in ISO 8601 format.
  - `calculated` boolean: Indicates whether the property is calculated.
  - `calculationFormula` string: The formula used to calculate the property's value, if applicable.
  - `createdAt` string, date-time: The date and time when this property was created, in ISO 8601 format.
  - `createdUserId` string: The ID of the user who created this property.
  - `currencyPropertyName` string: 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'.
  - `description` string, required: A description of the property.
  - `displayOrder` integer: The order in which this property is displayed relative to other properties.
  - `externalOptions` boolean: Indicates whether the property options are external.
  - `fieldType` string, required: The field type of the property.
  - `formField` boolean: Indicates whether the property is a form field.
  - `groupName` string, required: The name of the group to which this property belongs.
  - `hasUniqueValue` boolean: Indicates whether the property has a unique value.
  - `hidden` boolean: Indicates whether the property is hidden.
  - `hubspotDefined` boolean: Indicates whether the property is defined by HubSpot.
  - `label` string, required: The display label for the property.
  - `modificationMetadata` PropertyModificationMetadata
    - `archivable` boolean, required: A boolean indicating whether the property can be archived.
    - `readOnlyDefinition` boolean, required: A boolean indicating whether the definition of the property is read-only.
    - `readOnlyOptions` boolean: A boolean indicating whether the options of the property are read-only.
    - `readOnlyValue` boolean, required: A boolean indicating whether the value of the property is read-only.
  - `name` string, required: The unique name of the property.
  - `numberDisplayHint` 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted': A hint for displaying number properties, with valid values including 'unformatted', 'formatted', 'currency', 'percentage', 'duration', and 'probability'.
  - `options` Option[], required: An array of options available for this property, applicable if the property supports multiple values.
    - `description` string: A detailed description of the option, providing additional context.
    - `displayOrder` integer: An integer that determines the order in which the option appears relative to other options.
    - `hidden` boolean, required: A boolean indicating whether the option is hidden from users.
    - `label` string, required: The display name of the option, shown to users.
    - `value` string, required: The internal value associated with the option, used in data processing.
  - `referencedObjectType` string: The type of object that this property references.
  - `sensitiveDataCategories` string[]: An array of categories indicating the sensitivity of the data.
  - `showCurrencySymbol` boolean: Indicates whether a currency symbol is shown for the property.
  - `textDisplayHint` 'domain_name' | 'email' | 'ip_address' | 'multi_line' | 'phone_number' | 'physical_address' | 'postal_code' | 'unformatted_single_line': 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'.
  - `type` string, required: The data type of the property.
  - `updatedAt` string, date-time: The date and time when this property was last updated, in ISO 8601 format.
  - `updatedUserId` string: The ID of the user who last updated this property.

## Other responses

- `default`: An error occurred.

---

[API](https://skmtc.dev/hubspot/apis/events-manage-event-definitions.md) - [All operations](https://skmtc.dev/hubspot/apis/events-manage-event-definitions/llms.txt) - [OpenAPI document](https://skmtc.dev/hubspot/apis/events-manage-event-definitions/revisions/758db024626a?raw)