Account & Settings
Gestión de aplicaciones
Autenticación
Automatización
CMS
Communication preferences
Conversaciones
Eventos
Marketing
Scheduler
curl --request PATCH \
--url https://api.hubapi.com/events/2026-03/event-definitions/{eventName}/property/{propertyName} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"label": "<string>",
"options": [
{
"displayOrder": 123,
"hidden": true,
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
]
}
'{
"description": "<string>",
"fieldType": "<string>",
"groupName": "<string>",
"label": "<string>",
"name": "<string>",
"options": [
{
"hidden": true,
"label": "<string>",
"value": "<string>",
"description": "<string>",
"displayOrder": 123
}
],
"type": "<string>",
"archived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"calculated": true,
"calculationFormula": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdUserId": "<string>",
"currencyPropertyName": "<string>",
"dataSensitivity": "highly_sensitive",
"dateDisplayHint": "absolute",
"displayOrder": 123,
"externalOptions": true,
"formField": true,
"hasUniqueValue": true,
"hidden": false,
"hubspotDefined": true,
"modificationMetadata": {
"archivable": true,
"readOnlyDefinition": true,
"readOnlyValue": true,
"readOnlyOptions": true
},
"numberDisplayHint": "currency",
"referencedObjectType": "<string>",
"sensitiveDataCategories": [
"<string>"
],
"showCurrencySymbol": true,
"updatedAt": "2023-11-07T05:31:56Z",
"updatedUserId": "<string>"
}Update an event property
Update an existing property in a custom event definition.
curl --request PATCH \
--url https://api.hubapi.com/events/2026-03/event-definitions/{eventName}/property/{propertyName} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"label": "<string>",
"options": [
{
"displayOrder": 123,
"hidden": true,
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
]
}
'{
"description": "<string>",
"fieldType": "<string>",
"groupName": "<string>",
"label": "<string>",
"name": "<string>",
"options": [
{
"hidden": true,
"label": "<string>",
"value": "<string>",
"description": "<string>",
"displayOrder": 123
}
],
"type": "<string>",
"archived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"calculated": true,
"calculationFormula": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdUserId": "<string>",
"currencyPropertyName": "<string>",
"dataSensitivity": "highly_sensitive",
"dateDisplayHint": "absolute",
"displayOrder": 123,
"externalOptions": true,
"formField": true,
"hasUniqueValue": true,
"hidden": false,
"hubspotDefined": true,
"modificationMetadata": {
"archivable": true,
"readOnlyDefinition": true,
"readOnlyValue": true,
"readOnlyOptions": true
},
"numberDisplayHint": "currency",
"referencedObjectType": "<string>",
"sensitiveDataCategories": [
"<string>"
],
"showCurrencySymbol": true,
"updatedAt": "2023-11-07T05:31:56Z",
"updatedUserId": "<string>"
}Supported products
Supported products
Required Scopes
Required Scopes
Autorizaciones
The access token received from the authorization server in the OAuth 2.0 flow.
Cuerpo
A description of the property that will be shown as help text in HubSpot.
Human readable label for the property. Used in HubSpot UI
A list of available options for the property if it is an enumeration. NOTE: This field is only applicable for enumerated properties.
Show child attributes
Show child attributes
Respuesta
successful operation
A HubSpot property
A summary of the property's purpose.
Determines how the property will appear in HubSpot's UI or on a form. Learn more in the properties API guide.
The name of the group to which the property is assigned.
The display label for the property.
The internal name for the property.
A list of valid options for the property. This field is required for enumerated properties.
Show child attributes
Show child attributes
The data type of the property, such as string or number.
Whether the property is archived.
The timestamp when the property was archived, in ISO 8601 format.
Whether the property is a calculated field.
The formula used for calculated properties.
The timestamp when the property was created, in ISO 8601 format.
The ID of the user who created the property.
The name of the related currency property.
Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive".
highly_sensitive, non_sensitive, sensitive absolute, absolute_with_relative, time_since, time_until The position of the item relative to others in the list.
Applicable only for enumeration type properties. Should be set to true with a 'referencedObjectType' of 'OWNER'. Otherwise false.
Whether the property can appear on forms.
Whether the property is a unique identifier property.
Whether or not the property will be hidden from the HubSpot UI. It's recommended that this be set to false for custom properties.
false
A boolean value set to true for HubSpot default properties.
Show child attributes
Show child attributes
Hint for how a number property is displayed and validated in HubSpot's UI. Can be: "unformatted", "formatted", "currency", "percentage", "duration", or "probability".
currency, duration, formatted, percentage, probability, unformatted Deprecated. Use externalOptionsReferenceType instead.
When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA").
Whether to show the currency symbol in HubSpot's UI.
The timestamp when the property was last updated, in ISO 8601 format.