Skip to main content
POST
Criar propriedade

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 da definição de evento para a qual a propriedade está sendo criada.

Corpo

application/json
label
string
obrigatório

Uma string que representa o nome de exibição da propriedade. Este campo é obrigatório.

type
string
obrigatório

Uma string que indica o tipo de dados da propriedade. Este campo é obrigatório.

description
string

Uma string que fornece informações adicionais sobre a propriedade.

name
string

Uma string que representa o nome exclusivo da propriedade.

options
object[]

Uma matriz de objetos OptionInput que definem os valores possíveis para a propriedade.

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 matriz de opções disponíveis para esta propriedade, aplicável se a propriedade permitir vários valores.

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 o valor da 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, com valores válidos incluindo "non_sensitive", "sensitive" e "highly_sensitive".

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

Uma dica para exibir propriedades de data, com valores válidos incluindo '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 em relação a outras propriedades.

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 para exibir propriedades numéricas. 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.

showCurrencySymbol
boolean

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

textDisplayHint
enum<string>

Uma dica para exibir propriedades de texto, com valores válidos incluindo '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