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
propertyName
string
obrigatório

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

Propriedade do HubSpot

description
string
obrigatório

Um resumo da finalidade da propriedade.

fieldType
string
obrigatório

Determina como a propriedade aparecerá na interface do HubSpot ou em um formulário. Saiba mais no guia da API de propriedades.

groupName
string
obrigatório

O nome do grupo ao qual a propriedade é atribuída.

label
string
obrigatório

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

name
string
obrigatório

O nome interno da propriedade.

options
object[]
obrigatório

Uma lista de opções válidas para a propriedade. Este campo é obrigatório para propriedades enumeradas.

type
string
obrigatório

O tipo de dados da propriedade, como string ou número.

archived
boolean

Se a propriedade foi arquivada.

archivedAt
string<date-time>

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

calculated
boolean

Se a propriedade é um campo calculado.

calculationFormula
string

A fórmula usada para propriedades de cálculo.

createdAt
string<date-time>

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

createdUserId
string

O ID do usuário que criou a propriedade.

currencyPropertyName
string

O nome da propriedade de moeda relacionada.

dataSensitivity
enum<string>

Indica o nível de sensibilidade da propriedade, como "non_sensitive", "sensitive" ou "highly_sensitive".

Opções disponíveis:
highly_sensitive,
non_sensitive,
sensitive
dateDisplayHint
enum<string>
Opções disponíveis:
absolute,
absolute_with_relative,
time_since,
time_until
displayOrder
integer<int32>

A posição do item em relação aos outros na lista.

externalOptions
boolean

Aplicável apenas a propriedades do tipo enumeração. Deve ser definido como verdadeiro com um "referencedObjectType" de "PROPRIETÁRIO". Caso contrário, falso.

formField
boolean

Se a propriedade pode aparecer em formulários.

hasUniqueValue
boolean

Se a propriedade é uma propriedade de identificador exclusivo.

hidden
boolean

Se a propriedade será ou não ocultada da interface do HubSpot. É recomendado definir como falso para propriedades personalizadas.

Exemplo:

false

hubspotDefined
boolean

Um valor booleano definido como verdadeiro para propriedades padrão do HubSpot.

modificationMetadata
object
numberDisplayHint
enum<string>

Dica de como uma propriedade numérica é exibida e validada na interface do HubSpot. Pode ser: "sem formato", "formatado", "moeda", "porcentagem", "duração" ou "probabilidade".

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

Obsoleto. Em vez disso, use externalOptionsReferenceType.

sensitiveDataCategories
string[]

Quando sensitiveData é verdadeiro, lista o tipo de dados confidenciais contidos na propriedade (por exemplo, "HIPAA").

showCurrencySymbol
boolean

Se o símbolo da moeda deve ser exibido na interface do HubSpot.

textDisplayHint
enum<string>

Dica de como o texto é exibido e validado na interface do HubSpot. Pode ser: "unformatted_single_line", "multi_line", "email", "phone_number", "domain_name", "ip_address", "physical_address" ou "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 a propriedade foi atualizada pela última vez, no formato ISO 8601.

updatedUserId
string
Última modificação em 13 de abril de 2026