Saltar al contenido principal
POST
/
events
/
v3
/
event-definitions
/
{eventName}
/
property
Crear una propiedad para una definición 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>"
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Enterprise
Sales HubSales Hub -Enterprise
Service HubService Hub -Enterprise
Content HubContent Hub -Enterprise

Autorizaciones

​
Authorization
string
header
requerido

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

Parámetros de ruta

​
eventName
string
requerido

El nombre interno del evento personalizado.

Cuerpo

application/json
​
label
string
requerido

Etiqueta de la propiedad legible para humanos. Se utiliza en la UI de HubSpot.

​
type
string
requerido

El tipo de datos de la propiedad. Puede ser uno de los siguientes: [cadena, número, enumeración, fecha y hora]

​
description
string

Una descripción de la propiedad que se mostrará como texto de ayuda en HubSpot.

​
name
string

Nombre interno de la propiedad, que debe usarse al referenciar la propiedad desde la API

​
options
object[]

Una lista de opciones disponibles para la propiedad si se trata de una enumeración. NOTA: Este campo solo se puede aplicar para propiedades enumeradas.

Respuesta

successful operation

Propiedad de HubSpot

​
description
string
requerido

Un resumen de la finalidad de la propiedad.

​
fieldType
string
requerido

Determina cómo aparecerá la propiedad en la IU de HubSpot o en un formulario. Más información en la guía de la API de propiedades.

​
groupName
string
requerido

El nombre del grupo al que se asigna la propiedad.

​
label
string
requerido

La etiqueta de visualización de la propiedad.

​
name
string
requerido

El nombre interno de la propiedad.

​
options
object[]
requerido

Una lista de opciones válidas para la propiedad. Este campo es obligatorio para las propiedades enumeradas.

​
type
string
requerido

El tipo de datos de la propiedad, como cadena o número.

​
archived
boolean

Si la propiedad está archivada.

​
archivedAt
string<date-time>

La marca de tiempo en la que se archivó la propiedad, en formato ISO 8601.

​
calculated
boolean

Si la propiedad es un campo calculado.

​
calculationFormula
string

La fórmula que se usa para las propiedades calculadas.

​
createdAt
string<date-time>

La marca de tiempo en la que se creó la propiedad, en formato ISO 8601.

​
createdUserId
string

El ID del usuario que creó la propiedad.

​
dataSensitivity
enum<string>

Indica el nivel de sensibilidad de la propiedad, como "non_sensitive", "sensitive", or "highly_sensitive".

Opciones disponibles:
highly_sensitive,
non_sensitive,
sensitive
​
dateDisplayHint
enum<string>
Opciones disponibles:
absolute,
absolute_with_relative,
time_since,
time_until
​
displayOrder
integer<int32>

La posición del elemento en relación con otros de la lista.

​
externalOptions
boolean

Aplicable solo a propiedades de tipo de enumeración. Debe establecerse en verdadero con un "referencedObjectType" de "OWNER". De lo contrario, falso.

​
formField
boolean

Si la propiedad puede aparecer en los formularios.

​
hasUniqueValue
boolean

Si la propiedad es un identificador único.

​
hidden
boolean

Si la propiedad se ocultará o no de la IU de HubSpot. Se recomienda que esto se establezca en falso para las propiedades personalizadas.

Ejemplo:

false

​
hubspotDefined
boolean

Un valor booleano establecido en verdadero para las propiedades predeterminadas de HubSpot.

​
modificationMetadata
object
​
referencedObjectType
string

Obsoleto. Utiliza externalOptionsReferenceType en su lugar.

​
sensitiveDataCategories
string[]

Cuando sensitiveData es verdadero, enumera el tipo de datos sensibles contenidos en la propiedad (por ejemplo, "HIPAA").

​
showCurrencySymbol
boolean

Si se muestra el símbolo de la divisa en la IU de HubSpot.

​
updatedAt
string<date-time>

La marca de tiempo en la que se actualizó la propiedad, en formato ISO 8601.

​
updatedUserId
string
Last modified on February 12, 2026