Skip to main content
PATCH
Mettre à jour la propriété

Supported products

Autorisations

hapikey
string
query
requis

Paramètres de chemin

appId
integer<int32>
requis

L'identifiant unique de l'application associée à la propriété.

objectType
string
requis

Le type d'objet auquel appartient la propriété.

propertyName
string
requis

Le nom de la propriété à mettre à jour.

Corps

application/json
calculationFormula
string

Une chaîne représentant la formule utilisée pour calculer la valeur de la propriété.

currencyPropertyName
string

Une chaîne représentant le nom de la propriété monétaire associée à cette propriété.

description
string

Une chaîne fournissant une description de la propriété.

displayOrder
integer<int32>

Un entier indiquant l'ordre d'affichage de la propriété.

fieldType
enum<string>

Une chaîne spécifiant le type de champ de la propriété. Les valeurs valides incluent « booleancheckbox », « calculation_equation », « checkbox », « date​ », « file », « html », « number », « phonenumber », « radio », « select », « text » et « textarea ».

Options disponibles:
booleancheckbox,
calculation_equation,
checkbox,
date,
file,
html,
number,
phonenumber,
radio,
select,
text,
textarea
formField
boolean

Un booléen indiquant si la propriété est un champ de formulaire.

groupName
string

Une chaîne représentant le nom du groupe auquel appartient la propriété.

hasUniqueValue
boolean

Un booléen indiquant si la propriété a une valeur unique.

hidden
boolean

Un booléen indiquant si la propriété est masquée.

label
string

Une chaîne représentant le libellé d'affichage de la propriété.

numberDisplayHint
enum<string>

Une chaîne fournissant une indication sur la manière d'afficher les nombres. Les valeurs valides incluent « non formaté », « formaté », « devise », « pourcentage », « durée » et « probabilité ».

Options disponibles:
currency,
duration,
formatted,
percentage,
probability,
unformatted
options
object[]

Un tableau d'objets OptionInput représentant les options disponibles pour la propriété.

showCurrencySymbol
boolean

Un booléen indiquant s'il faut afficher le symbole monétaire pour la propriété.

textDisplayHint
enum<string>

Une chaîne fournissant une indication sur la manière d'afficher le texte. Les valeurs valides incluent : « 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
type
enum<string>

Une chaîne indiquant le type de données de la propriété. Les valeurs valides incluent « bool », « date », « datetime », « enumeration », « number », « phone_number » et « string ».

Options disponibles:
bool,
date,
datetime,
enumeration,
number,
phone_number,
string

Réponse

successful operation

A HubSpot property

allowedObjectTypes
object[]
requis

Un tableau de chaînes de caractères représentant les types d'objets autorisés pour cette propriété.

calculated
boolean
requis

Un booléen indiquant si la propriété est calculée.

canArchive
boolean
requis

Un booléen indiquant si la propriété peut être archivée.

canRestore
boolean
requis

Un booléen indiquant si la propriété peut être restaurée.

createdAt
integer<int64>
requis

Une chaîne représentant la date et l'heure de création de la propriété, au format ISO 8601.

createdUserId
integer<int64>
requis

Chaîne représentant l'ID de l'utilisateur qui a créé la propriété.

currencyPropertyName
string
requis

Une chaîne représentant le nom de la propriété de devise associée à cette propriété.

dataSensitivity
enum<string>
requis

Une chaîne indiquant le niveau de sensibilité des données.

Options disponibles:
high,
none,
standard
dateDisplayHint
enum<string>
requis

Une chaîne fournissant une indication pour l'affichage des dates.

Options disponibles:
absolute,
absolute_with_relative,
time_since,
time_until
deleted
boolean
requis

Un booléen indiquant si la propriété a été supprimée.

description
string
requis

Une chaîne fournissant une description de la propriété.

displayMode
enum<string>
requis

Une chaîne indiquant le mode d'affichage de la propriété.

Options disponibles:
all_unique_versions,
current_value
displayOrder
integer<int32>
requis

Un entier spécifiant l'ordre dans lequel la propriété est affichée.

enforceMultivalueUniqueness
boolean
requis

Un booléen indiquant si l'unicité est appliquée pour les propriétés à valeurs multiples.

externalOptions
boolean
requis

Une propriété booléenne indiquant si la propriété a des options externes.

externalOptionsReferenceType
string
requis

Chaîne indiquant le type de référence pour les options externes.

favorited
boolean
requis

Un booléen indiquant si la propriété est marquée comme favorite.

favoritedOrder
integer<int32>
requis

Un entier spécifiant l'ordre de la propriété parmi les favoris.

fieldType
string
requis

Une chaîne indiquant le type de champ de la propriété, tel que « booleancheckbox », « calculation_equation », « checkbox », « date », « file », « html », « number », « phonenumber », « radio », « select », « text » ou « textarea ».

formField
boolean
requis

Un booléen indiquant si la propriété est utilisée comme champ de formulaire.

fromUserId
integer<int64>
requis

Une chaîne représentant l'ID utilisateur à l'origine de la propriété.

groupName
string
requis

Une chaîne représentant le nom du groupe auquel appartient la propriété.

hasUniqueValue
boolean
requis

Un booléen indiquant si la propriété a une valeur unique.

hidden
boolean
requis

Un booléen indiquant si la propriété est masquée.

Exemple:

false

hubspotDefined
boolean
requis

Un booléen indiquant si la propriété est définie par HubSpot.

isCustomizedDefault
boolean
requis

Un booléen indiquant si la propriété est une valeur par défaut personnalisée.

isMultiValued
boolean
requis

Un booléen indiquant si la propriété peut avoir plusieurs valeurs.

isPartial
boolean
requis

Un booléen indiquant si la propriété est partielle.

label
string
requis

Une chaîne représentant le libellé de la propriété, utilisée à des fins d'affichage.

mutableDefinitionNotDeletable
boolean
requis

Un booléen indiquant si la définition de la propriété est modifiable mais non supprimable.

name
string
requis

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

numberDisplayHint
enum<string>
requis

Une chaîne fournissant une indication pour l'affichage des nombres, avec des options telles que « non formaté », « formaté », « devise », « pourcentage », « durée » ou « probabilité ».

Options disponibles:
currency,
duration,
formatted,
percentage,
probability,
unformatted
optionSortStrategy
enum<string>
requis

Une chaîne indiquant la stratégie utilisée pour trier les options.

Options disponibles:
ALPHABETICAL,
DISPLAY_ORDER
options
object[]
requis

Un éventail d'options disponibles pour la propriété, applicable si le type de propriété prend en charge les options.

optionsAreMutable
boolean
requis

Un booléen indiquant si les options de la propriété sont mutables.

owningAppId
integer<int64>
requis

Un entier représentant l'ID de l'application propriétaire de la propriété.

portalId
integer<int64>
requis

Un entier représentant l'identifiant unique du portail.

readOnlyDefinition
boolean
requis

Un booléen indiquant si la propriété est en lecture seule.

readOnlyValue
boolean
requis

Un booléen indiquant si la valeur de la propriété est en lecture seule.

referencedObjectType
enum<string>
requis

Une chaîne indiquant le type d'objet référencé par la propriété.

Options disponibles:
ABANDONED_CART,
ACCEPTANCE_TEST,
AD,
AD_ACCOUNT,
AD_CAMPAIGN,
AD_GROUP,
AI_FORECAST,
ALL_PAGES,
APPROVAL,
APPROVAL_STEP,
ATTRIBUTION,
AUDIENCE,
AUTOMATION_JOURNEY,
AUTOMATION_PLATFORM_FLOW,
AUTOMATION_PLATFORM_FLOW_ACTION,
BET_ALERT,
BET_DELIVERABLE_SERVICE,
BLOG_LISTING_PAGE,
BLOG_POST,
CALL,
CAMPAIGN,
CAMPAIGN_BUDGET_ITEM,
CAMPAIGN_SPEND_ITEM,
CAMPAIGN_STEP,
CAMPAIGN_TEMPLATE,
CAMPAIGN_TEMPLATE_STEP,
CART,
CASE_STUDY,
CHATFLOW,
CLIP,
CMS_URL,
COMBO_EVENT_CONFIGURATION,
COMMERCE_PAYMENT,
COMMUNICATION,
COMPANY,
CONTACT,
CONTACT_CREATE_ATTRIBUTION,
CONTENT,
CONTENT_AUDIT,
CONTENT_AUDIT_PAGE,
CONVERSATION,
CONVERSATION_INBOX,
CONVERSATION_SESSION,
CRM_OBJECTS_DUMMY_TYPE,
CRM_PIPELINES_DUMMY_TYPE,
CTA,
CTA_VARIANT,
DATA_PRIVACY_CONSENT,
DATA_SYNC_STATE,
DEAL,
DEAL_CREATE_ATTRIBUTION,
DEAL_REGISTRATION,
DEAL_SPLIT,
DISCOUNT,
DISCOUNT_CODE,
DISCOUNT_TEMPLATE,
EMAIL,
ENGAGEMENT,
EXPORT,
EXTERNAL_WEB_URL,
FEE,
FEEDBACK_SUBMISSION,
FEEDBACK_SURVEY,
FILE_MANAGER_FILE,
FILE_MANAGER_FOLDER,
FOLDER,
FORECAST,
FORM,
FORM_SUBMISSION_INBOUNDDB,
GOAL_TARGET,
GOAL_TARGET_GROUP,
GOAL_TEMPLATE,
GSC_PROPERTY,
HUB,
IMPORT,
INVOICE,
KEYWORD,
KNOWLEDGE_ARTICLE,
LANDING_PAGE,
LEAD,
LINE_ITEM,
MARKETING_CALENDAR,
MARKETING_CAMPAIGN_UTM,
MARKETING_EMAIL,
MARKETING_EVENT,
MARKETING_EVENT_ATTENDANCE,
MARKETING_SMS,
MEDIA_BRIDGE,
MEETING_EVENT,
MIC,
NOTE,
OBJECT_LIST,
ORDER,
OWNER,
PARTNER_ACCOUNT,
PARTNER_CLIENT,
PARTNER_CLIENT_REVENUE,
PARTNER_SERVICE,
PAYMENT_LINK,
PAYMENT_SCHEDULE,
PAYMENT_SCHEDULE_INSTALLMENT,
PERMISSIONS_TESTING,
PLAYBOOK,
PLAYBOOK_QUESTION,
PLAYBOOK_SUBMISSION,
PLAYBOOK_SUBMISSION_ANSWER,
PLAYLIST,
PLAYLIST_FOLDER,
PODCAST_EPISODE,
PORTAL,
PORTAL_OBJECT_SYNC_MESSAGE,
POSTAL_MAIL,
PRIVACY_SCANNER_COOKIE,
PRODUCT,
PRODUCT_OR_FOLDER,
PROPERTY_INFO,
PROSPECTING_AGENT_CONTACT_ASSIGNMENT,
PUBLISHING_TASK,
QUARANTINED_SUBMISSION,
QUOTA,
QUOTE,
QUOTE_FIELD,
QUOTE_MODULE,
QUOTE_MODULE_FIELD,
QUOTE_TEMPLATE,
RESTORABLE_CRM_OBJECT,
ROSTER,
ROSTER_MEMBER,
SALES_DOCUMENT,
SALES_TASK,
SALES_WORKLOAD,
SALESFORCE_SYNC_ERROR,
SCHEDULING_PAGE,
SCHEMAS_BACKEND_TEST,
SCORE_CONFIGURATION,
SEQUENCE,
SEQUENCE_ENROLLMENT,
SEQUENCE_STEP,
SEQUENCE_STEP_ENROLLMENT,
SERVICE,
SITE_PAGE,
SNIPPET,
SOCIAL_BROADCAST,
SOCIAL_CHANNEL,
SOCIAL_POST,
SOCIAL_PROFILE,
SOX_PROTECTED_DUMMY_TYPE,
SOX_PROTECTED_TEST_TYPE,
SUBMISSION_TAG,
SUBSCRIPTION,
TASK,
TASK_TEMPLATE,
TAX,
TEMPLATE,
TICKET,
UNKNOWN,
UNSUBSCRIBE,
USER,
VIEW,
VIEW_BLOCK,
WEB_INTERACTIVE
searchTextAnalysisMode
enum<string>
requis

Une chaîne indiquant le mode d'analyse de texte à des fins de recherche.

Options disponibles:
NONE,
NOT_ANALYZED_TEXT

Un booléen indiquant si la propriété peut faire l'objet d'une recherche globale.

sensitiveDataCategories
string[]
requis

Un tableau de chaînes de caractères représentant les catégories de données sensibles associées à cette propriété.

showCurrencySymbol
boolean
requis

Un booléen indiquant si le symbole monétaire doit être affiché pour la propriété.

textDisplayHint
enum<string>
requis

Une chaîne fournissant une indication pour l'affichage du texte, avec des options telles que « unformatted_single_line », « multi_line », « email », « phone_number », « domain_name », « ip_address », « physical_address » ou « postal_code ».

Options disponibles:
domain_name,
email,
ip_address,
multi_line,
phone_number,
physical_address,
postal_code,
unformatted_single_line
type
enum<string>
requis

Une chaîne de caractères indiquant le type de la propriété, tel que « bool », « date », « datetime », « enumeration », « number », « phone_number » ou « string ».

Options disponibles:
bool,
currency_number,
date,
datetime,
enumeration,
json,
number,
object_coordinates,
phone_number,
string,
time_range
updatedAt
integer<int64>
requis

Une chaîne représentant la date et l'heure de la dernière mise à jour de la propriété, au format ISO 8601.

Dernière modification le 6 octobre 2026