Skip to main content
PATCH
Update a property

Supported products

Autorisations

hapikey
string
query
requis

Paramètres de chemin

appId
integer<int32>
requis
objectType
string
requis
propertyName
string
requis

Corps

application/json
calculationFormula
string
currencyPropertyName
string
description
string
displayOrder
integer<int32>
fieldType
enum<string>
Options disponibles:
booleancheckbox,
calculation_equation,
checkbox,
date,
file,
html,
number,
phonenumber,
radio,
select,
text,
textarea
formField
boolean
groupName
string
hasUniqueValue
boolean
hidden
boolean
label
string
numberDisplayHint
enum<string>
Options disponibles:
currency,
duration,
formatted,
percentage,
probability,
unformatted
options
object[]
showCurrencySymbol
boolean
textDisplayHint
enum<string>
Options disponibles:
domain_name,
email,
ip_address,
multi_line,
phone_number,
physical_address,
postal_code,
unformatted_single_line
type
enum<string>
Options disponibles:
bool,
date,
datetime,
enumeration,
number,
phone_number,
string

Réponse

successful operation

A HubSpot property

allowedObjectTypes
object[]
requis

Object types permitted to use this property.

calculated
boolean
requis

Whether the property is a calculated field.

canArchive
boolean
requis
canRestore
boolean
requis
createdAt
integer<int64>
requis

The timestamp when the property was created, in ISO 8601 format.

createdUserId
integer<int64>
requis

The ID of the user who created the property.

currencyPropertyName
string
requis

The name of the related currency property.

dataSensitivity
enum<string>
requis

Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive".

Options disponibles:
high,
none,
standard
dateDisplayHint
enum<string>
requis
Options disponibles:
absolute,
absolute_with_relative,
time_since,
time_until
deleted
boolean
requis

Whether the property has been deleted.

description
string
requis

A summary of the property's purpose.

displayMode
enum<string>
requis

The mode in which the property is displayed. Can be: "current_value" or "all_unique_versions".

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

The position of the item relative to others in the list.

enforceMultivalueUniqueness
boolean
requis
externalOptions
boolean
requis

Applicable only for enumeration type properties. Should be set to true with a 'referencedObjectType' of 'OWNER'. Otherwise false.

externalOptionsReferenceType
string
requis

When externalOptions is true, indicates the property's option values will be populated from other systems (e.g., "OWNER" for the hubspot_owner_id property).

favorited
boolean
requis

Deprecated. Whether the property is marked as a favorite.

favoritedOrder
integer<int32>
requis

Deprecated. The order position when marked as favorited.

fieldType
string
requis

Determines how the property will appear in HubSpot's UI or on a form. Learn more in the properties API guide.

formField
boolean
requis

Whether the property can appear on forms.

fromUserId
integer<int64>
requis

The ID of the user who last updated the property.

groupName
string
requis

The name of the group to which the property is assigned.

hasUniqueValue
boolean
requis

Whether the property is a unique identifier property.

hidden
boolean
requis

Whether or not the property will be hidden from the HubSpot UI. It's recommended that this be set to false for custom properties.

Exemple:

false

hubspotDefined
boolean
requis

A boolean value set to true for HubSpot default properties.

isCustomizedDefault
boolean
requis

For default properties, whether the property has been customized. Equivalent to the 'isCustomizedDefault' field.

isMultiValued
boolean
requis

Whether the property can contain multiple values.

isPartial
boolean
requis

For default properties, whether the property has been customized. Equivalent to the 'isCustomizedDefault' field.

label
string
requis

The display label for the property.

mutableDefinitionNotDeletable
boolean
requis

Whether the property definition can be customized but not deleted.

name
string
requis

The internal name for the property.

numberDisplayHint
enum<string>
requis

Hint for how a number property is displayed and validated in HubSpot's UI. Can be: "unformatted", "formatted", "currency", "percentage", "duration", or "probability".

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

Specifies how to sort property options. Can be either "DISPLAY_ORDER" to defer to the displayOrder field, or "ALPHABETICAL".

Options disponibles:
ALPHABETICAL,
DISPLAY_ORDER
options
object[]
requis

A list of valid options for the property. This field is required for enumerated properties.

optionsAreMutable
boolean
requis

Whether options can be modified after creation.

owningAppId
integer<int64>
requis
portalId
integer<int64>
requis

The ID of the HubSpot account where the property is defined.

readOnlyDefinition
boolean
requis

Whether the property's description is read-only.

readOnlyValue
boolean
requis

Indicates if the property's value is read-only.

referencedObjectType
enum<string>
requis

Deprecated. Use externalOptionsReferenceType instead.

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
Options disponibles:
NONE,
NOT_ANALYZED_TEXT

Whether the property is searchable globaly.

sensitiveDataCategories
string[]
requis

When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA").

showCurrencySymbol
boolean
requis

Whether to show the currency symbol in HubSpot's UI.

textDisplayHint
enum<string>
requis

Hint for how the text is displayed and validated in HubSpot's UI. Can be: "unformatted_single_line", "multi_line", "email", "phone_number", "domain_name", "ip_address", "physical_address", or "postal_code".

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

The data type of the property, such as string or number.

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

The timestamp when the property was last updated, in ISO 8601 format.

Dernière modification le 6 octobre 2026