---
title: "Changes to Update an existing custom event property"
method: PATCH
path: "/events/v3/event-definitions/{eventName}/property/{propertyName}"
---

# Changes to Update an existing custom event property

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

> Every recorded change to this operation, newest first.

## Timeline

Changed in 40 of 141 revisions.

- **2026-08-14** (v3) `b12482347df4`: 1 info
- **2026-07-13** (v3) `8d341c0a911c`: 1 breaking
- **2026-07-13** (v3) `7afd5ac6fbf1`: 1 info
- **2026-07-13** (v3) `ae745d244e14`: 1 breaking
- **2026-06-16** (v3) `9842d96d5c67`: 2 breaking
- **2026-06-16** (v3) `3101530c65bf`: 2 info
- **2026-06-15** (v3) `9842d96d5c67`: 2 breaking, 1 warning
- **2026-06-15** (v3) `ccd8162a29fa`: 2 info
- **2026-06-09** (v3) `9842d96d5c67`: 2 breaking
- **2026-06-09** (v3) `3101530c65bf`: 2 info
- **2026-06-05** (v3) `9842d96d5c67`: 2 breaking
- **2026-06-05** (v3) `3101530c65bf`: 2 info
- **2026-06-03** (v3) `50e3766125f5`: 2 breaking
- **2026-06-03** (v3) `3d7b8deb2f28`: 2 info
- **2026-06-02** (v3) `50e3766125f5`: 2 breaking
- **2026-06-02** (v3) `3d7b8deb2f28`: 2 info
- **2026-06-01** (v3) `50e3766125f5`: 2 breaking
- **2026-06-01** (v3) `3d7b8deb2f28`: 2 info
- **2026-05-27** (v3) `50e3766125f5`: 2 breaking
- **2026-05-27** (v3) `3d7b8deb2f28`: 2 info
- **2026-05-26** (v3) `50e3766125f5`: 1 info
- **2026-05-26** (v3) `9028f1ff9bf9`: 2 breaking
- **2026-05-26** (v3) `2d9ebdddd778`: 2 info
- **2026-05-25** (v3) `9028f1ff9bf9`: 2 breaking
- **2026-05-25** (v3) `2d9ebdddd778`: 2 info
- **2026-05-22** (v3) `9028f1ff9bf9`: 2 info
- **2026-05-20** (v3) `4fe0932c7e21`: 2 breaking
- **2026-05-20** (v3) `cea1c2aa4d10`: 2 info
- **2026-05-19** (v3) `4fe0932c7e21`: 2 breaking
- **2026-05-19** (v3) `cea1c2aa4d10`: 2 info
- **2026-05-15** (v3) `4fe0932c7e21`: 2 breaking
- **2026-05-15** (v3) `cea1c2aa4d10`: 2 info
- **2026-04-20** (v3) `08613de113bd`: 4 info
- **2026-04-09** (v3) `c33aebb4b2f8`: 9 info
- **2026-04-01** (v3) `92a55bb7168e`: 2 info
- **2026-01-12** (v3) `bf466fa030ec`: 1 info
- **2025-11-05** (v3) `57d7d02df1d0`: 2 info
- **2025-10-26** (v3) `22a2454ecf46`: 4 info
- **2024-06-21** (v3) `a7185ee004f2`: 2 info
- **2024-03-29** (v3) `65a4c322e991`: 2 info

## 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`
- **2026-06-16** (v3) `3101530c65bf`: 2 info
  - the response property `options/items/description` became required for the status `201`
  - the response property `options/items/displayOrder` became required for the status `201`
- **2026-06-15** (v3) `9842d96d5c67`: 2 breaking, 1 warning
  - the response property `options/items/description` became optional for the status `201`
  - the response property `options/items/displayOrder` became optional for the status `201`
  - the optional response header `Location` removed for the status `201`
- **2026-06-15** (v3) `ccd8162a29fa`: 2 info
  - the response property `options/items/description` became required for the status `201`
  - the response property `options/items/displayOrder` became required for the status `201`
- **2026-06-09** (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`
- **2026-06-09** (v3) `3101530c65bf`: 2 info
  - the response property `options/items/description` became required for the status `201`
  - the response property `options/items/displayOrder` became required for the status `201`
- **2026-06-05** (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`
- **2026-06-05** (v3) `3101530c65bf`: 2 info
  - the response property `options/items/description` became required for the status `201`
  - the response property `options/items/displayOrder` became required for the status `201`
- **2026-06-03** (v3) `50e3766125f5`: 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`
- **2026-06-03** (v3) `3d7b8deb2f28`: 2 info
  - the response property `options/items/description` became required for the status `201`
  - the response property `options/items/displayOrder` became required for the status `201`
- **2026-06-02** (v3) `50e3766125f5`: 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`
- **2026-06-02** (v3) `3d7b8deb2f28`: 2 info
  - the response property `options/items/description` became required for the status `201`
  - the response property `options/items/displayOrder` became required for the status `201`
- **2026-06-01** (v3) `50e3766125f5`: 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`
- **2026-06-01** (v3) `3d7b8deb2f28`: 2 info
  - the response property `options/items/description` became required for the status `201`
  - the response property `options/items/displayOrder` became required for the status `201`
- **2026-05-27** (v3) `50e3766125f5`: 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`
- **2026-05-27** (v3) `3d7b8deb2f28`: 2 info
  - the response property `options/items/description` became required for the status `201`
  - the response property `options/items/displayOrder` became required for the status `201`
- **2026-05-26** (v3) `50e3766125f5`: 1 info
  - added the optional property `textDisplayHint` to the response with the `201` status
- **2026-05-26** (v3) `9028f1ff9bf9`: 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`
- **2026-05-26** (v3) `2d9ebdddd778`: 2 info
  - the response property `options/items/description` became required for the status `201`
  - the response property `options/items/displayOrder` became required for the status `201`
- **2026-05-25** (v3) `9028f1ff9bf9`: 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`
- **2026-05-25** (v3) `2d9ebdddd778`: 2 info
  - the response property `options/items/description` became required for the status `201`
  - the response property `options/items/displayOrder` became required for the status `201`
- **2026-05-22** (v3) `9028f1ff9bf9`: 2 info
  - the security scope `behavioral_events.event_definitions.read_write` was added to the endpoint's security scheme `oauth2`
  - the security scope `behavioral-events-external-api` was removed from the endpoint's security scheme `oauth2`
- **2026-05-20** (v3) `4fe0932c7e21`: 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`
- **2026-05-20** (v3) `cea1c2aa4d10`: 2 info
  - the response property `options/items/description` became required for the status `201`
  - the response property `options/items/displayOrder` became required for the status `201`
- **2026-05-19** (v3) `4fe0932c7e21`: 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`
- **2026-05-19** (v3) `cea1c2aa4d10`: 2 info
  - the response property `options/items/description` became required for the status `201`
  - the response property `options/items/displayOrder` became required for the status `201`
- **2026-05-15** (v3) `4fe0932c7e21`: 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`
- **2026-05-15** (v3) `cea1c2aa4d10`: 2 info
  - the response property `options/items/description` became required for the status `201`
  - the response property `options/items/displayOrder` became required for the status `201`
- **2026-04-20** (v3) `08613de113bd`: 4 info
  - the endpoint scheme security `app_cookie` was removed from the API
  - the endpoint scheme security `hapikey` was removed from the API
  - the endpoint scheme security `internal_cookie` was removed from the API
  - the endpoint scheme security `shhkey` was removed from the API
- **2026-04-09** (v3) `c33aebb4b2f8`: 9 info
  - the endpoint scheme security `app_cookie` was added to the API
  - the endpoint scheme security `hapikey` was added to the API
  - the endpoint scheme security `internal_cookie` was added to the API
  - the endpoint scheme security `shhkey` was added to the API
  - the endpoint scheme security `private_apps` was removed from the API
  - the security scope `behavioral-events-external-api` was added to the endpoint's security scheme `oauth2`
  - the security scope `behavioral_events.event_definitions.read_write` was removed from the endpoint's security scheme `oauth2`
  - added the optional property `currencyPropertyName` to the response with the `201` status
  - added the optional property `numberDisplayHint` to the response with the `201` status
- **2026-04-01** (v3) `92a55bb7168e`: 2 info
  - api tag `Basic` added
  - api tag `External_Events_Definition` removed
- **2026-01-12** (v3) `bf466fa030ec`: 1 info
  - added the optional property `dateDisplayHint` to the response with the `201` status
- **2025-11-05** (v3) `57d7d02df1d0`: 2 info
  - api tag `External_Events_Definition` added
  - api tag `Event definition` removed
- **2025-10-26** (v3) `22a2454ecf46`: 4 info
  - the endpoint scheme security `oauth2` was added to the API
  - the endpoint scheme security `private_apps` was added to the API
  - the endpoint scheme security `oauth2_legacy` was removed from the API
  - the endpoint scheme security `private_apps_legacy` was removed from the API
- **2024-06-21** (v3) `a7185ee004f2`: 2 info
  - added the optional property `dataSensitivity` to the response with the `201` status
  - added the optional property `sensitiveDataCategories` to the response with the `201` status
- **2024-03-29** (v3) `65a4c322e991`: 2 info
  - api tag `Event definition` added
  - api tag `External_Events_Definition` removed

---

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