Sign in

v4

latestOpenAPI 3.0.12026-07-131319154.6 KB
Basic

Update a property

Perform a partial update of a property identified by {propertyName}. Provided fields will be overwritten.

patch/crm/properties/2026-09/{objectType}/{propertyName}

Path parameters

objectTypestring required
propertyNamestring required

Request body

calculationFormulastring

Represents a formula that is used to compute a calculated property.

descriptionstring

A description of the property that will be shown as help text in HubSpot.

displayOrderinteger

Property groups are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property group to be displayed after any positive values.

fieldType'booleancheckbox' | 'calculation_equation' | 'checkbox' | 'date' | 'file' | 'html' | 'number' | 'phonenumber' | 'radio' | 'select' | 'text' | 'textarea'

Controls how the property appears in HubSpot.

formFieldboolean

Whether or not the property can be used in a HubSpot form.

groupNamestring

The name of the property group the property belongs to.

hiddenboolean

If true, the property won't be visible and can't be used in HubSpot.

labelstring

A human-readable label that will be shown in HubSpot.

type'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'

The data type of the property.

Response

successful operation

archivedboolean

Whether or not the property is archived.

archivedAtstring date-time

When the property was archived.

calculatedboolean

For default properties, true indicates that the property is calculated by a HubSpot process. It has no effect for custom properties.

calculationFormulastring

Represents a formula that is used to compute a calculated property.

createdAtstring date-time

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

createdUserIdstring

The internal user ID of the user who created the property in HubSpot. This field may not exist if the property was created outside of HubSpot.

dataSensitivity'highly_sensitive' | 'non_sensitive' | 'sensitive'

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

dateDisplayHint'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'
descriptionstring required

A description of the property that will be shown as help text in HubSpot.

displayOrderinteger

Property groups are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property group to be displayed after any positive values.

externalOptionsboolean

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

fieldTypestring required

Controls how the property appears in HubSpot.

formFieldboolean

Whether or not the property can be used in a HubSpot form.

groupNamestring required

The name of the property group the property belongs to.

hasUniqueValueboolean

Whether or not the property's value must be unique. Once set, this can't be changed.

hiddenboolean

If true, the property won't be visible and can't be used in HubSpot.

hubspotDefinedboolean

This will be true for default object properties built into HubSpot.

labelstring required

A human-readable label that will be shown in HubSpot.

namestring required

The name of the property to read or modify.

referencedObjectTypestring

Should be set to 'OWNER' when 'externalOptions' is true, which causes the property to dynamically pull option values from the current HubSpot users.

sensitiveDataCategoriesstring[]

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

showCurrencySymbolboolean

Whether or not the property will display the currency symbol set in the account settings.

typestring required

The data type of the property.

updatedAtstring date-time

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

updatedUserIdstring

The internal user ID of the user who updated the property in HubSpot. This field may not exist if the property was updated outside of HubSpot.