Passer au contenu principal
POST
/
events
/
v3
/
event-definitions
/
{eventName}
/
property
Créer une propriété pour une définition d'événement
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>"
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Entreprise
Sales HubSales Hub -Entreprise
Service HubService Hub -Entreprise
Content HubContent Hub -Entreprise

Autorisations

​
Authorization
string
header
requis

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

Paramètres de chemin

​
eventName
string
requis

Le nom interne de l'événement personnalisé.

Corps

application/json
​
label
string
requis

Libellé lisible par la personne pour la propriété. Utilisé dans l'IU de HubSpot

​
type
string
requis

Le type de données de la propriété. Peut être l'un des suivants : [chaîne, nombre, énumération, date et heure]

​
description
string

Une description de la propriété qui sera affichée comme texte d'aide dans HubSpot.

​
name
string

Nom interne de la propriété, qui doit être utilisé lorsque la propriété est référencée depuis l'API

​
options
object[]

Une liste d'options disponibles pour la propriété s'il s'agit d'une énumération. NOTE : ce champ ne s'applique qu'aux propriétés énumérées.

Réponse

successful operation

Propriété HubSpot

​
description
string
requis

Un résumé de l'objectif de la propriété.

​
fieldType
string
requis

Détermine comment la propriété apparaîtra dans l'interface utilisateur de HubSpot ou sur un formulaire. Pour en savoir plus, consultez le guide de l'API sur les propriétés.

​
groupName
string
requis

Le nom du groupe auquel la propriété est attribuée.

​
label
string
requis

Le libellé d'affichage de la propriété.

​
name
string
requis

Le nom interne de la propriété.

​
options
object[]
requis

Une liste d'options valides pour la propriété. Ce champ est requis pour les propriétés énumérées.

​
type
string
requis

Le type de données de la propriété, par exemple une chaîne ou un nombre.

​
archived
boolean

Indique si la propriété est archivée.

​
archivedAt
string<date-time>

Date et heure d'archivage de la propriété, au format ISO 8601.

​
calculated
boolean

Si la propriété est un champ calculé.

​
calculationFormula
string

La formule utilisée pour les propriétés calculées.

​
createdAt
string<date-time>

Date à laquelle la propriété a été créée, au format ISO 8601.

​
createdUserId
string

L'ID de l'utilisateur qui a créé la propriété.

​
dataSensitivity
enum<string>

Indique le niveau de sensibilité de la propriété, par exemple « non_sensitive », « sensitive » ou « highly_sensitive ».

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

La position de l'élément par rapport aux autres éléments de la liste.

​
externalOptions
boolean

Applicable uniquement aux propriétés de type « énumération ». Doit être définie sur « true » avec un « referencedObjectType » de « OWNER ». Sinon, définir sur « false ».

​
formField
boolean

Si la propriété peut apparaître sur les formulaires.

​
hasUniqueValue
boolean

Indique si la propriété est une propriété à identifiant unique.

​
hidden
boolean

Si la propriété sera masquée de l'interface utilisateur HubSpot ou non. Il est recommandé de laisser la valeur définie sur « faux » pour les propriétés personnalisées.

Exemple:

false

​
hubspotDefined
boolean

Une valeur booléenne fixée à true pour les propriétés par défaut de HubSpot.

​
modificationMetadata
object
​
referencedObjectType
string

Obsolète. Utilisez plutôt externalOptionsReferenceType.

​
sensitiveDataCategories
string[]

Lorsque sensitiveData est vrai, liste le type de données sensibles contenues dans la propriété (par exemple, « HIPAA »).

​
showCurrencySymbol
boolean

Afficher ou non le symbole de la devise dans l'interface utilisateur de HubSpot.

​
updatedAt
string<date-time>

L'horodatage du moment où la propriété a été mise à jour pour la dernière fois, au format ISO 8601.

​
updatedUserId
string
Last modified on February 12, 2026