HubSpot: Update property

← Event definitions operations · Get started

Operation hubspot.event_definitions_update_event_property

Provider route: PATCH /events/2026-09/event-definitions/{eventName}/property/{propertyName}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["eventDefinitions"]["updateEventProperty"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.eventDefinitions.updateEventProperty(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.event_definitions.update_event_property(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.eventName	string	Required within parent
path.propertyName	string	Required within parent
body	Model	Required within parent	Expand Update property — request body — body

Referenced models: Update property — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Create Property — response body

Referenced models: Create Property — response body

Schemas

Update property — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	A description of the property that will be shown as help text in HubSpot.
displayOrder	integer	Optional	For not hidden properties, indicates the order to display the property on the record's activity timeline (ex: displayOrder: 0 is at the top). Format: int32
hidden	boolean	Optional	Controls whether or not this property is displayed on the record's activity timeline.
label	string	Optional	Human readable label for the property. Used in HubSpot UI.
options	array	Optional	A list of available options for the property if it is an enumeration. NOTE: This field is only applicable for enumerated properties.
options[]	Model	Each item	Expand Create Property — request body — body options item

Referenced models: Create Property — request body — body options item

Create Property — response body

Field	Type	Presence	Description and constraints
$	object	Root	A HubSpot property
archived	boolean	Optional	Indicates whether the property is archived.
archivedAt	string	Optional	The date and time when this property was archived, in ISO 8601 format. Format: date-time
calculated	boolean	Optional	Indicates whether the property is calculated.
calculationFormula	string	Optional	The formula used to calculate the property's value, if applicable.
createdAt	string	Optional	The date and time when this property was created, in ISO 8601 format. Format: date-time
createdUserId	string	Optional	The ID of the user who created this property.
currencyPropertyName	string	Optional	The name of the currency property associated with this property.
dataSensitivity	string	Optional	The sensitivity level of the data, with valid values including 'non_sensitive', 'sensitive', and 'highly_sensitive'. Known values: highly_sensitive, non_sensitive, sensitive
dateDisplayHint	string	Optional	A hint for displaying date properties, with valid values including 'absolute', 'absolute_with_relative', 'time_since', and 'time_until'. Known values: absolute, absolute_with_relative, time_since, time_until
description	string	Required within parent	A description of the property.
displayOrder	JSON	Optional
displayOrder (anyOf 1)	integer	Alternative	The order in which this property is displayed relative to other properties. Format: int32
displayOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
externalOptions	boolean	Optional	Indicates whether the property options are external.
fieldType	string	Required within parent	The field type of the property.
formField	boolean	Optional	Indicates whether the property is a form field.
groupName	string	Required within parent	The name of the group to which this property belongs.
hasUniqueValue	boolean	Optional	Indicates whether the property has a unique value.
hidden	boolean	Optional	Indicates whether the property is hidden.
hubspotDefined	boolean	Optional	Indicates whether the property is defined by HubSpot.
label	string	Required within parent	The display label for the property.
modificationMetadata	Model	Optional	Expand Create Property — response body — modification Metadata
name	string	Required within parent	The unique name of the property.
numberDisplayHint	string	Optional	A hint for displaying number properties, with valid values including 'unformatted', 'formatted', 'currency', 'percentage', 'duration', and 'probability'. Known values: currency, duration, formatted, percentage, probability, unformatted
options	array	Required within parent	An array of options available for this property, applicable if the property supports multiple values.
options[]	Model	Each item	Expand Create Property — response body — options item
referencedObjectType	string	Optional	The type of object that this property references.
sensitiveDataCategories	array	Optional	An array of categories indicating the sensitivity of the data.
sensitiveDataCategories[]	string	Each item
showCurrencySymbol	boolean	Optional	Indicates whether a currency symbol is shown for the property.
textDisplayHint	string	Optional	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'. Known values: domain_name, email, ip_address, multi_line, phone_number, physical_address, postal_code, unformatted_single_line
type	string	Required within parent	The data type of the property.
updatedAt	string	Optional	The date and time when this property was last updated, in ISO 8601 format. Format: date-time
updatedUserId	string	Optional	The ID of the user who last updated this property.

Referenced models: Create Property — response body — modification Metadata, Create Property — response body — options item

Create Property — request body — body options item

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	A string providing additional information about the option.
displayOrder	integer	Required within parent	An integer indicating the order in which the option should be displayed relative to other options. Format: int32
hidden	boolean	Required within parent	A boolean indicating whether the option is hidden from view.
label	string	Required within parent	A string representing the display label for the option.
value	string	Required within parent	A string representing the unique value associated with the option.

Create Property — response body — modification Metadata

Field	Type	Presence	Description and constraints
$	object	Root
archivable	boolean	Required within parent	A boolean indicating whether the property can be archived.
readOnlyDefinition	boolean	Required within parent	A boolean indicating whether the definition of the property is read-only.
readOnlyOptions	boolean	Optional	A boolean indicating whether the options of the property are read-only.
readOnlyValue	boolean	Required within parent	A boolean indicating whether the value of the property is read-only.

Create Property — response body — options item

Field	Type	Presence	Description and constraints
$	object	Root	A HubSpot property option
description	string	Optional	A detailed description of the option, providing additional context.
displayOrder	JSON	Optional
displayOrder (anyOf 1)	integer	Alternative	An integer that determines the order in which the option appears relative to other options. Format: int32
displayOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hidden	boolean	Required within parent	A boolean indicating whether the option is hidden from users.
label	string	Required within parent	The display name of the option, shown to users.
value	string	Required within parent	The internal value associated with the option, used in data processing.

Policy, approvals and errors

SDK function policy ID: hubspot.event_definitions_update_event_property. Catalog operation: event_definitions_update_event_property. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["behavioral_events.event_definitions.read_write"]

Official provider source