Zum Hauptinhalt springen
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 '{
  "name": "<string>",
  "options": [
    {
      "hidden": true,
      "displayOrder": 123,
      "description": "<string>",
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "description": "<string>",
  "label": "<string>",
  "type": "<string>"
}'
{
  "hidden": false,
  "displayOrder": 123,
  "description": "",
  "showCurrencySymbol": false,
  "type": "",
  "hubspotDefined": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "archived": false,
  "options": "",
  "hasUniqueValue": false,
  "calculated": false,
  "externalOptions": false,
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdUserId": "",
  "modificationMetadata": {
    "readOnlyOptions": true,
    "readOnlyValue": true,
    "readOnlyDefinition": true,
    "archivable": true
  },
  "sensitiveDataCategories": "",
  "label": "",
  "formField": false,
  "dataSensitivity": "",
  "archivedAt": "2023-11-07T05:31:56Z",
  "groupName": "",
  "referencedObjectType": "",
  "name": "",
  "calculationFormula": "",
  "fieldType": "",
  "updatedUserId": "<string>"
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubEnterprise
Sales HubSales HubEnterprise
Service HubService HubEnterprise
Content HubContent HubEnterprise

​
Escopos Necessários

Esta API requer um dos seguintes escopos:
  • behavioral_events.event_definitions.read_write

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
eventName
string
required

O nome interno do evento personalizado.

Body

application/json
​
label
string
required

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

​
type
string
required

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

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

​
description
string

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

Response

successful operation

A HubSpot property

​
description
string
required

A summary of the property's purpose.

Example:

""

​
type
string
required

The data type of the property, such as string or number.

Example:

""

​
options
object[]
required

A list of valid options for the property. This field is required for enumerated properties.

Example:

""

​
label
string
required

The display label for the property.

Example:

""

​
groupName
string
required

The name of the group to which the property is assigned.

Example:

""

​
name
string
required

The internal name for the property.

Example:

""

​
fieldType
string
required

Determines how the property will appear in HubSpot's UI or on a form. Learn more in the properties API guide.

Example:

""

​
hidden
boolean

Whether or not the property will be hidden from the HubSpot UI. It's recommended that this be set to false for custom properties.

Example:

false

​
displayOrder
integer

The position of the item relative to others in the list.

​
showCurrencySymbol
boolean

Whether to show the currency symbol in HubSpot's UI.

Example:

false

​
hubspotDefined
boolean

A boolean value set to true for HubSpot default properties.

Example:

false

​
createdAt
string<date-time>

The timestamp when the property was created, in ISO 8601 format.

​
archived
boolean

Whether the property is archived.

Example:

false

​
hasUniqueValue
boolean

Whether the property is a unique identifier property.

Example:

false

​
calculated
boolean

Whether the property is a calculated field.

Example:

false

​
externalOptions
boolean

Applicable only for enumeration type properties. Should be set to true with a 'referencedObjectType' of 'OWNER'. Otherwise false.

Example:

false

​
updatedAt
string<date-time>

The timestamp when the property was last updated, in ISO 8601 format.

​
createdUserId
string

The ID of the user who created the property.

Example:

""

​
modificationMetadata
object
​
sensitiveDataCategories
string[]

When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA").

Example:

""

​
formField
boolean

Whether the property can appear on forms.

Example:

false

​
dataSensitivity
enum<string>

Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive".

Available options:
non_sensitive,
sensitive,
highly_sensitive
Example:

""

​
archivedAt
string<date-time>

The timestamp when the property was archived, in ISO 8601 format.

​
referencedObjectType
string

Deprecated. Use externalOptionsReferenceType instead.

Example:

""

​
calculationFormula
string

The formula used for calculated properties.

Example:

""

​
updatedUserId
string
⌘I