Account & Settings
Gestion des applications
Authentification
Automatisation
CMS
Communication preferences
Conversations
CRM
Événements
Fichiers
Marketing
Scheduler
curl --request POST \
--url https://api.hubapi.com/crm/properties/2026-03/{objectType} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fieldType": "booleancheckbox",
"groupName": "<string>",
"label": "<string>",
"name": "<string>",
"type": "bool",
"calculationFormula": "<string>",
"currencyPropertyName": "<string>",
"dataSensitivity": "highly_sensitive",
"description": "<string>",
"displayOrder": 123,
"externalOptions": true,
"formField": true,
"hasUniqueValue": true,
"hidden": true,
"numberDisplayHint": "currency",
"options": [
{
"displayOrder": 123,
"hidden": true,
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
],
"referencedObjectType": "<string>",
"showCurrencySymbol": true
}
'{
"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>",
"currencyPropertyName": "<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
},
"numberDisplayHint": "currency",
"referencedObjectType": "<string>",
"sensitiveDataCategories": [
"<string>"
],
"showCurrencySymbol": true,
"updatedAt": "2023-11-07T05:31:56Z",
"updatedUserId": "<string>"
}Create a property
Créer et renvoyer une copie d’une nouvelle propriété pour le type d’objet spécifié.
curl --request POST \
--url https://api.hubapi.com/crm/properties/2026-03/{objectType} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fieldType": "booleancheckbox",
"groupName": "<string>",
"label": "<string>",
"name": "<string>",
"type": "bool",
"calculationFormula": "<string>",
"currencyPropertyName": "<string>",
"dataSensitivity": "highly_sensitive",
"description": "<string>",
"displayOrder": 123,
"externalOptions": true,
"formField": true,
"hasUniqueValue": true,
"hidden": true,
"numberDisplayHint": "currency",
"options": [
{
"displayOrder": 123,
"hidden": true,
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
],
"referencedObjectType": "<string>",
"showCurrencySymbol": true
}
'{
"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>",
"currencyPropertyName": "<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
},
"numberDisplayHint": "currency",
"referencedObjectType": "<string>",
"sensitiveDataCategories": [
"<string>"
],
"showCurrencySymbol": true,
"updatedAt": "2023-11-07T05:31:56Z",
"updatedUserId": "<string>"
}Supported products
Supported products
Required Scopes
Required Scopes
Autorisations
The access token received from the authorization server in the OAuth 2.0 flow.
Paramètres de chemin
Corps
Contrôle la façon dont la propriété apparaît dans HubSpot.
booleancheckbox, calculation_equation, checkbox, date, file, html, number, phonenumber, radio, select, text, textarea Le nom du groupe de propriétés auquel appartient la propriété.
Un libellé de propriété qui sera affichée dans HubSpot lisible par les personnes.
Le nom interne de la propriété, qui doit être utilisé lorsque la propriété est référencée par le biais de l'API.
Le type de données de la propriété.
bool, date, datetime, enumeration, number, phone_number, string Cela représente une formule utilisée pour calculer une propriété calculée.
Indique le niveau de sensibilité de la propriété, avec les options suivantes : highly_sensitive, non_sensitive ou sensitive.
highly_sensitive, non_sensitive, sensitive Une description de la propriété qui sera affichée comme texte d'aide dans HubSpot.
Les propriétés sont affichées dans l'ordre croissant en partant de la valeur entière positive la plus basse. Une valeur -1 fera apparaître la propriété après toute valeur positive.
Applicable uniquement aux propriétés de type « énumération ». Doit être définie sur « true » en conjonction avec un « referencedObjectType » de « OWNER ». Sinon, définir sur « false ».
Si la propriété peut être utilisée dans un formulaire HubSpot ou non.
Si la valeur de la propriété doit être unique ou non. Une fois définie, il n'est pas possible de le modifier.
Si vrai, la propriété ne sera pas visible et ne pourra pas être utilisée dans HubSpot.
currency, duration, formatted, percentage, probability, unformatted Une liste d'options valides pour la propriété. Ce champ est requis pour les propriétés énumérées.
Show child attributes
Show child attributes
Cela doit être défini sur « OWNER » lorsque la valeur de « externalOptions » est « vrai », et entraîne l'extraction dynamique des valeurs des options des utilisateurs actuels de HubSpot par la propriété.
Réponse
successful operation
Propriété HubSpot
Une description de la propriété qui sera affichée comme texte d'aide dans HubSpot.
Contrôle la façon dont la propriété apparaît dans HubSpot.
Le nom du groupe de propriétés auquel appartient la propriété.
Un libellé de propriété qui sera affichée dans HubSpot lisible par les personnes.
Le nom interne de la propriété, qui doit être utilisé lorsque la propriété est référencée par le biais de l'API.
Une liste d'options valides pour la propriété. Ce champ est requis pour les propriétés énumérées, mais sera vide pour les autres types de propriétés.
Show child attributes
Show child attributes
Le type de données de la propriété.
Si la propriété est archivée ou non.
Moment où la propriété a été archivée
Pour les propriétés par défaut, vrai indique que la propriété est calculée par un processus HubSpot. Cela n'a aucun effet pour les propriétés personnalisées.
Cela représente une formule utilisée pour calculer une propriété calculée.
Date à laquelle la propriété a été créée, au format ISO 8601.
L'ID utilisateur interne de l'utilisateur qui a créé la propriété dans HubSpot. Ce champ peut ne pas exister si la propriété a été créée en dehors de HubSpot.
Le nom de la propriété de la devise associée.
Indique le niveau de sensibilité de la propriété, par exemple « non_sensitive », « sensitive » ou « highly_sensitive ».
highly_sensitive, non_sensitive, sensitive Indique comment les valeurs de date doivent être affichées, avec des options telles que « absolute », « absolute_with_relative », « time_since » ou « time_until ».
absolute, absolute_with_relative, time_since, time_until Les propriétés sont affichées dans l'ordre croissant en partant de la valeur entière positive la plus basse.
Par défaut, vrai indique que les options sont stockées en dehors des paramètres de propriété.
Si la propriété peut être utilisée dans un formulaire HubSpot ou non.
Si la valeur de la propriété doit être unique ou non. Une fois définie, il n'est pas possible de le modifier.
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.
false
Cette valeur sera « vrai » pour les propriétés d'objet par défaut intégrées dans HubSpot.
Show child attributes
Show child attributes
Indication sur la manière dont une propriété numérique est affichée et validée dans l'interface utilisateur de HubSpot. Peut être : « non formaté », « formaté », « devise », « pourcentage », « durée » ou « probabilité ».
currency, duration, formatted, percentage, probability, unformatted Si cette propriété est liée à un ou plusieurs autres objets, ils seront répertoriés ici.
Lorsque sensitiveData est vrai, liste le type de données sensibles contenues dans la propriété (par exemple, « HIPAA »).
Si la propriété affiche ou non le symbole de la devise défini dans les paramètres du compte.
L'horodatage du moment où la propriété a été mise à jour pour la dernière fois, au format ISO 8601.
L'ID utilisateur interne de l'utilisateur qui a mis à jour la propriété dans HubSpot. Ce champ peut ne pas exister si la propriété a été mise à jour en dehors de HubSpot.