Skip to main content
PATCH
Actualizar propiedad

Supported products

Autorizaciones

Authorization
string
header
requerido

The access token received from the authorization server in the OAuth 2.0 flow.

Parámetros de ruta

eventName
string
requerido

El identificador único del evento cuya propiedad quieres actualizar.

propertyName
string
requerido

El nombre de la propiedad que se actualizará dentro del evento especificado.

Cuerpo

application/json
description
string

Una descripción de la propiedad que se mostrará como texto de ayuda en HubSpot.

displayOrder
integer<int32>

Para las propiedades no ocultas, indica el orden en que se muestra la propiedad en la cronología de actividad del registro (ej: displayOrder: 0 está en la parte superior).

hidden
boolean

Controla si esta propiedad se muestra o no en la cronología de actividad del registro.

label
string

Etiqueta de la propiedad legible para humanos. Se utiliza en la UI de HubSpot.

options
object[]

Una lista de opciones disponibles para la propiedad si se trata de una enumeración. NOTA: Este campo solo se puede aplicar para propiedades enumeradas.

Respuesta

successful operation

A HubSpot property

description
string
requerido

Una descripción de la propiedad.

fieldType
string
requerido

El tipo de campo de la propiedad.

groupName
string
requerido

El nombre del grupo al que pertenece esta propiedad.

label
string
requerido

La etiqueta de visualización de la propiedad.

name
string
requerido

El nombre único de la propiedad.

options
object[]
requerido

Un conjunto de opciones disponibles para esta propiedad, aplicable si la propiedad admite múltiples valores.

type
string
requerido

El tipo de datos de la propiedad.

archived
boolean

Indica si la propiedad está archivada.

archivedAt
string<date-time>

La fecha y hora en que se archivó esta propiedad, en formato ISO 8601.

calculated
boolean

Indica si la propiedad se calcula.

calculationFormula
string

La fórmula utilizada para calcular el valor de la propiedad, si corresponde.

createdAt
string<date-time>

La fecha y hora en que se creó esta propiedad, en formato ISO 8601.

createdUserId
string

El ID del usuario que creó esta propiedad.

currencyPropertyName
string

El nombre de la propiedad de divisa asociada a esta propiedad.

dataSensitivity
enum<string>

El nivel de sensibilidad de los datos, con valores válidos que incluyen "non_sensitive", "sensitive" y "highly_sensitive".

Opciones disponibles:
highly_sensitive,
non_sensitive,
sensitive
dateDisplayHint
enum<string>

Una sugerencia para mostrar propiedades de fecha, con valores válidos que incluyen "absolute", "absolute_with_relative", "time_since" y "time_until".

Opciones disponibles:
absolute,
absolute_with_relative,
time_since,
time_until
displayOrder
integer<int32>

El orden en que se muestra esta propiedad en relación con otras propiedades.

externalOptions
boolean

Indica si las opciones de la propiedad son externas.

formField
boolean

Indica si la propiedad es un campo de formulario.

hasUniqueValue
boolean

Indica si la propiedad tiene un valor único.

hidden
boolean

Indica si la propiedad está oculta.

Ejemplo:

false

hubspotDefined
boolean

Indica si la propiedad está definida por HubSpot.

modificationMetadata
object
numberDisplayHint
enum<string>

Una sugerencia para mostrar propiedades numéricas, con valores válidos que incluyen "unformatted", "formatted", "currency", "percentage", "duration" y "probability".

Opciones disponibles:
currency,
duration,
formatted,
percentage,
probability,
unformatted
referencedObjectType
string

El tipo de objeto al que hace referencia esta propiedad.

sensitiveDataCategories
string[]

Un conjunto de categorías que indican la sensibilidad de los datos.

showCurrencySymbol
boolean

Indica si se muestra un símbolo de divisa para la propiedad.

textDisplayHint
enum<string>

Una sugerencia para mostrar las propiedades de texto, con valores válidos que incluyen "unformatted_single_line", "multi_line", "email", "phone_number", "domain_name", "ip_address", "physical_address" y "postal_code".

Opciones disponibles:
domain_name,
email,
ip_address,
multi_line,
phone_number,
physical_address,
postal_code,
unformatted_single_line
updatedAt
string<date-time>

La fecha y hora en que esta propiedad se actualizó por última vez, en formato ISO 8601.

updatedUserId
string

El ID del usuario que actualizó esta propiedad por última vez.

Última modificación el 6 de octubre de 2026