---
title: "Update an existing custom event property"
method: PATCH
path: "/events/v3/event-definitions/{eventName}/property/{propertyName}"
tags: ["Basic"]
---

# Update an existing custom event property

`PATCH /events/v3/event-definitions/{eventName}/property/{propertyName}`

## Request

- Base URL: `https://api.hubapi.com`
- URL: `https://api.hubapi.com/events/v3/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 an existing property in a custom event definition.

## 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.
  - `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
    - `displayOrder` integer, required
    - `hidden` boolean, required
    - `label` string, required
    - `value` string, required

## Response `201`

successful operation

- Property: A HubSpot property
  - `archived` boolean: Whether the property is archived.
  - `archivedAt` string, date-time: The timestamp when the property was archived, in ISO 8601 format.
  - `calculated` boolean: Whether the property is a calculated field.
  - `calculationFormula` string: The formula used for calculated properties.
  - `createdAt` string, date-time: The timestamp when the property was created, in ISO 8601 format.
  - `createdUserId` string: The ID of the user who created the property.
  - `currencyPropertyName` string: 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'
  - `description` string, required: A summary of the property's purpose.
  - `displayOrder` integer: The position of the item relative to others in the list.
  - `externalOptions` boolean: Applicable only for enumeration type properties. Should be set to true with a 'referencedObjectType' of 'OWNER'. Otherwise false.
  - `fieldType` string, required: Determines how the property will appear in HubSpot's UI or on a form. Learn more in the properties API guide.
  - `formField` boolean: Whether the property can appear on forms.
  - `groupName` string, required: The name of the group to which the property is assigned.
  - `hasUniqueValue` boolean: Whether the property is a unique identifier property.
  - `hidden` boolean: Whether or not the property will be hidden from the HubSpot UI. It's recommended that this be set to false for custom properties.
  - `hubspotDefined` boolean: A boolean value set to true for HubSpot default properties.
  - `label` string, required: The display label for the property.
  - `modificationMetadata` PropertyModificationMetadata
    - `archivable` boolean, required
    - `readOnlyDefinition` boolean, required
    - `readOnlyOptions` boolean
    - `readOnlyValue` boolean, required
  - `name` string, required: The internal name for the property.
  - `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".
  - `options` Option[], required: A list of valid options for the property. This field is required for enumerated properties.
    - `description` string: A description of the option.
    - `displayOrder` integer: The position of the item relative to others in the list.
    - `hidden` boolean, required: Whether the option is displayed in HubSpot's UI.
    - `label` string, required: A user-friendly label that identifies the option.
    - `value` string, required: The actual value of the option.
  - `referencedObjectType` string: Deprecated. Use externalOptionsReferenceType instead.
  - `sensitiveDataCategories` string[]: When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA").
  - `showCurrencySymbol` boolean: Whether to show the currency symbol in HubSpot's UI.
  - `textDisplayHint` 'domain_name' | 'email' | 'ip_address' | 'multi_line' | 'phone_number' | 'physical_address' | 'postal_code' | 'unformatted_single_line': Hint for how the text is displayed and validated in HubSpot's UI. Can be: "unformatted_single_line", "multi_line", "email", "phone_number", "domain_name", "ip_address", "physical_address", or "postal_code".
  - `type` string, required: The data type of the property, such as string or number.
  - `updatedAt` string, date-time: The timestamp when the property was last updated, in ISO 8601 format.
  - `updatedUserId` string

## Other responses

- `default`: An error occurred.

## Changes

- **2026-08-14** (v3) `b12482347df4`: 1 info
  - endpoint added
- **2026-07-13** (v3) `8d341c0a911c`: 1 breaking
  - api path removed without deprecation
- **2026-07-13** (v3) `7afd5ac6fbf1`: 1 info
  - endpoint added
- **2026-07-13** (v3) `ae745d244e14`: 1 breaking
  - api path removed without deprecation
- **2026-06-16** (v3) `9842d96d5c67`: 2 breaking
  - the response property `options/items/description` became optional for the status `201`
  - the response property `options/items/displayOrder` became optional for the status `201`

[Operation history](https://skmtc.dev/hubspot/apis/events-manage-event-definitions/changes/events/v3/event-definitions/:eventName/property/:propertyName/patch.md)

---

[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/49b86c29a335?raw)
