Pular para o conteúdo principal
POST
/
events
/
v3
/
event-definitions
/
{eventName}
/
property
Criar uma propriedade para uma definição de evento
curl --request POST \
  --url https://api.hubapi.com/events/v3/event-definitions/{eventName}/property \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "type": "<string>",
  "description": "<string>",
  "name": "<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>",
  "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
  },
  "referencedObjectType": "<string>",
  "sensitiveDataCategories": [
    "<string>"
  ],
  "showCurrencySymbol": true,
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedUserId": "<string>"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Enterprise
Sales HubSales Hub -Enterprise
Service HubService Hub -Enterprise
Content HubContent Hub -Enterprise

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 nome interno do evento personalizado.

Corpo

application/json
​
label
string
obrigatório

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

​
type
string
obrigatório

O tipo de dados da propriedade. Pode ser um dos seguintes: [string, número, enumeração, data e hora]

​
description
string

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

​
name
string

Nome interno da propriedade, que deve ser usado ao referenciar a propriedade pela API.

​
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.

​
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
​
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.

​
updatedAt
string<date-time>

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

​
updatedUserId
string
Last modified on March 24, 2026