Passer au contenu principal
POST
Créer une propriété

Supported products

Autorisations

Authorization
string
header
requis

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

Scopes

behavioral_events.event_definitions.read_write

Paramètres de chemin

eventName
string
requis

L'identifiant unique de la définition d'événement pour laquelle la propriété est créée.

Corps

application/json
label
string
requis

Une chaîne représentant le nom d'affichage de la propriété. Ce champ est obligatoire.

type
string
requis

Une chaîne indiquant le type de données de la propriété. Ce champ est obligatoire.

description
string

Une chaîne fournissant des informations supplémentaires sur la propriété.

name
string

Une chaîne représentant le nom unique de la propriété.

options
object[]

Un tableau d'objets OptionInput qui définissent les valeurs possibles pour la propriété.

Réponse

successful operation

A HubSpot property

description
string
requis

Une description de la propriété.

fieldType
string
requis

Le type de champ de la propriété.

groupName
string
requis

Le nom du groupe auquel appartient cette propriété.

label
string
requis

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

name
string
requis

Le nom unique de la propriété.

options
object[]
requis

Un éventail d'options disponibles pour cette propriété, applicable si la propriété prend en charge plusieurs valeurs.

type
string
requis

Le type de données de la propriété.

archived
boolean

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

archivedAt
string<date-time>

La date et l'heure d'archivage de cette propriété, au format ISO 8601.

calculated
boolean

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

calculationFormula
string

La formule utilisée pour calculer la valeur de la propriété, le cas échéant.

createdAt
string<date-time>

La date et l'heure de création de cette propriété, au format ISO 8601.

createdUserId
string

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

currencyPropertyName
string

Le nom de la propriété de devise associée à cette propriété.

dataSensitivity
enum<string>

Le niveau de sensibilité des données, avec des valeurs valides incluant « non_sensitive », « sensitive » et « highly_sensitive ».

Options disponibles:
highly_sensitive,
non_sensitive,
sensitive
dateDisplayHint
enum<string>

Une indication pour l'affichage des propriétés de date, avec des valeurs valides incluant « absolute », « absolute_with_relative », « time_since » et « time_until ».

Options disponibles:
absolute,
absolute_with_relative,
time_since,
time_until
displayOrder
integer<int32>

L'ordre dans lequel cette propriété est affichée par rapport aux autres propriétés.

externalOptions
boolean

Indique si les options de la propriété sont externes.

formField
boolean

Indique si la propriété est un champ de formulaire.

hasUniqueValue
boolean

Indique si la propriété a une valeur unique.

hidden
boolean

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

Exemple:

false

hubspotDefined
boolean

Indique si la propriété est définie par HubSpot.

modificationMetadata
object
numberDisplayHint
enum<string>

Une indication pour l'affichage des propriétés numériques, avec des valeurs valides incluant « non formaté », « formaté », « devise », « pourcentage », « durée » et « probabilité ».

Options disponibles:
currency,
duration,
formatted,
percentage,
probability,
unformatted
referencedObjectType
string

Le type d'objet auquel cette propriété fait référence.

sensitiveDataCategories
string[]

Un ensemble de catégories indiquant la sensibilité des données.

showCurrencySymbol
boolean

Indique si un symbole monétaire est affiché pour la propriété.

textDisplayHint
enum<string>

Une indication pour l'affichage des propriétés de texte, avec des valeurs valides : « unformatted_single_line », « multi_line », « email », « phone_number », « domain_name », « ip_address », « physical_address » et « postal_code ».

Options disponibles:
domain_name,
email,
ip_address,
multi_line,
phone_number,
physical_address,
postal_code,
unformatted_single_line
updatedAt
string<date-time>

La date et l'heure de la dernière mise à jour de cette propriété, au format ISO 8601.

updatedUserId
string

L'ID de l'utilisateur qui a mis à jour cette propriété en dernier.

Dernière modification le 6 octobre 2026