Pular para o conteúdo principal
PATCH
Atualizar uma propriedade de evento personalizado existente

Supported products

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

eventName
string
obrigatório

O identificador exclusivo do evento cuja propriedade você deseja atualizar.

propertyName
string
obrigatório

O identificador exclusivo da propriedade a ser atualizada dentro do evento especificado.

Corpo

application/json
description
string

Uma descrição da propriedade que será exibida como texto de ajuda no HubSpot.

label
string

Rótulo legível por humanos para a propriedade. Usado na interface do HubSpot

options
object[]

Uma lista de opções disponíveis para a propriedade se for uma enumeração. OBSERVAÇÃO: este campo se aplica apenas a propriedades enumeradas.

Resposta

successful operation

A HubSpot property

description
string
obrigatório

Uma descrição da propriedade.

fieldType
string
obrigatório

O tipo de campo da propriedade.

groupName
string
obrigatório

O nome do grupo ao qual esta propriedade pertence.

label
string
obrigatório

O rótulo de exibição da propriedade.

name
string
obrigatório

O nome exclusivo da propriedade.

options
object[]
obrigatório

Uma variedade de opções disponíveis para esta propriedade, cada uma definida por um rótulo, valor e outros atributos.

type
string
obrigatório

O tipo de dados da propriedade.

archived
boolean

Indica se a propriedade está arquivada.

archivedAt
string<date-time>

A data e hora em que esta propriedade foi arquivada, no formato ISO 8601.

calculated
boolean

Indica se a propriedade é calculada.

calculationFormula
string

A fórmula usada para calcular a propriedade, se aplicável.

createdAt
string<date-time>

A data e a hora em que esta propriedade foi criada, no formato ISO 8601.

createdUserId
string

O ID do usuário que criou esta propriedade.

currencyPropertyName
string

O nome da propriedade de moeda associada a esta propriedade.

dataSensitivity
enum<string>

O nível de confidencialidade dos dados. Os valores válidos incluem "non_sensitive", "sensitive" e "highly_sensitive".

Opções disponíveis:
highly_sensitive,
non_sensitive,
sensitive
dateDisplayHint
enum<string>

Uma dica de como os valores de data devem ser exibidos. Os valores válidos incluem 'absolute', 'absolute_with_relative', 'time_since' e 'time_until'.

Opções disponíveis:
absolute,
absolute_with_relative,
time_since,
time_until
displayOrder
integer<int32>

A ordem em que esta propriedade é exibida.

externalOptions
boolean

Indica se as opções da propriedade são externas.

formField
boolean

Indica se a propriedade é um campo de formulário.

hasUniqueValue
boolean

Indica se a propriedade tem um valor exclusivo.

hidden
boolean

Indica se a propriedade está oculta.

Exemplo:

false

hubspotDefined
boolean

Indica se a propriedade é definida pelo HubSpot.

modificationMetadata
object
numberDisplayHint
enum<string>

Uma dica de como os valores numéricos devem ser exibidos. Os valores válidos incluem "unformatted", "formatted", "currency", "percentage", "duration" e "probability".

Opções disponíveis:
currency,
duration,
formatted,
percentage,
probability,
unformatted
referencedObjectType
string

O tipo de objeto que esta propriedade referencia.

sensitiveDataCategories
string[]

Uma matriz de categorias que indicam a confidencialidade dos dados contidos na propriedade.

showCurrencySymbol
boolean

Indica se um símbolo de moeda é exibido para a propriedade.

textDisplayHint
enum<string>

Uma dica de como os valores de texto devem ser exibidos. Os valores válidos incluem 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address' e 'postal_code'.

Opções disponíveis:
domain_name,
email,
ip_address,
multi_line,
phone_number,
physical_address,
postal_code,
unformatted_single_line
updatedAt
string<date-time>

A data e hora em que esta propriedade foi atualizada pela última vez, no formato ISO 8601.

updatedUserId
string

O ID do usuário que atualizou esta propriedade pela última vez.

Última modificação em 6 de outubro de 2026