Skip to main content
PATCH
/
crm
/
v3
/
properties
/
{objectType}
/
{propertyName}
Update a property
curl --request PATCH \
  --url https://api.hubapi.com/crm/v3/properties/{objectType}/{propertyName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayOrder": 2,
  "fieldType": "select",
  "formField": true,
  "groupName": "contactinformation",
  "hidden": false,
  "label": "My Contact Property",
  "name": "my_contact_property",
  "options": [
    {
      "description": "Choice number one",
      "displayOrder": 1,
      "hidden": false,
      "label": "Option A",
      "value": "A"
    },
    {
      "description": "Choice number two",
      "displayOrder": 2,
      "hidden": false,
      "label": "Option B",
      "value": "B"
    }
  ],
  "type": "enumeration"
}
'
import requests

url = "https://api.hubapi.com/crm/v3/properties/{objectType}/{propertyName}"

payload = {
    "displayOrder": 2,
    "fieldType": "select",
    "formField": True,
    "groupName": "contactinformation",
    "hidden": False,
    "label": "My Contact Property",
    "name": "my_contact_property",
    "options": [
        {
            "description": "Choice number one",
            "displayOrder": 1,
            "hidden": False,
            "label": "Option A",
            "value": "A"
        },
        {
            "description": "Choice number two",
            "displayOrder": 2,
            "hidden": False,
            "label": "Option B",
            "value": "B"
        }
    ],
    "type": "enumeration"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    displayOrder: 2,
    fieldType: 'select',
    formField: true,
    groupName: 'contactinformation',
    hidden: false,
    label: 'My Contact Property',
    name: 'my_contact_property',
    options: [
      {
        description: 'Choice number one',
        displayOrder: 1,
        hidden: false,
        label: 'Option A',
        value: 'A'
      },
      {
        description: 'Choice number two',
        displayOrder: 2,
        hidden: false,
        label: 'Option B',
        value: 'B'
      }
    ],
    type: 'enumeration'
  })
};

fetch('https://api.hubapi.com/crm/v3/properties/{objectType}/{propertyName}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/crm/v3/properties/{objectType}/{propertyName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'displayOrder' => 2,
    'fieldType' => 'select',
    'formField' => true,
    'groupName' => 'contactinformation',
    'hidden' => false,
    'label' => 'My Contact Property',
    'name' => 'my_contact_property',
    'options' => [
        [
                'description' => 'Choice number one',
                'displayOrder' => 1,
                'hidden' => false,
                'label' => 'Option A',
                'value' => 'A'
        ],
        [
                'description' => 'Choice number two',
                'displayOrder' => 2,
                'hidden' => false,
                'label' => 'Option B',
                'value' => 'B'
        ]
    ],
    'type' => 'enumeration'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/crm/v3/properties/{objectType}/{propertyName}"

	payload := strings.NewReader("{\n  \"displayOrder\": 2,\n  \"fieldType\": \"select\",\n  \"formField\": true,\n  \"groupName\": \"contactinformation\",\n  \"hidden\": false,\n  \"label\": \"My Contact Property\",\n  \"name\": \"my_contact_property\",\n  \"options\": [\n    {\n      \"description\": \"Choice number one\",\n      \"displayOrder\": 1,\n      \"hidden\": false,\n      \"label\": \"Option A\",\n      \"value\": \"A\"\n    },\n    {\n      \"description\": \"Choice number two\",\n      \"displayOrder\": 2,\n      \"hidden\": false,\n      \"label\": \"Option B\",\n      \"value\": \"B\"\n    }\n  ],\n  \"type\": \"enumeration\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.hubapi.com/crm/v3/properties/{objectType}/{propertyName}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayOrder\": 2,\n  \"fieldType\": \"select\",\n  \"formField\": true,\n  \"groupName\": \"contactinformation\",\n  \"hidden\": false,\n  \"label\": \"My Contact Property\",\n  \"name\": \"my_contact_property\",\n  \"options\": [\n    {\n      \"description\": \"Choice number one\",\n      \"displayOrder\": 1,\n      \"hidden\": false,\n      \"label\": \"Option A\",\n      \"value\": \"A\"\n    },\n    {\n      \"description\": \"Choice number two\",\n      \"displayOrder\": 2,\n      \"hidden\": false,\n      \"label\": \"Option B\",\n      \"value\": \"B\"\n    }\n  ],\n  \"type\": \"enumeration\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/crm/v3/properties/{objectType}/{propertyName}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"displayOrder\": 2,\n  \"fieldType\": \"select\",\n  \"formField\": true,\n  \"groupName\": \"contactinformation\",\n  \"hidden\": false,\n  \"label\": \"My Contact Property\",\n  \"name\": \"my_contact_property\",\n  \"options\": [\n    {\n      \"description\": \"Choice number one\",\n      \"displayOrder\": 1,\n      \"hidden\": false,\n      \"label\": \"Option A\",\n      \"value\": \"A\"\n    },\n    {\n      \"description\": \"Choice number two\",\n      \"displayOrder\": 2,\n      \"hidden\": false,\n      \"label\": \"Option B\",\n      \"value\": \"B\"\n    }\n  ],\n  \"type\": \"enumeration\"\n}"

response = http.request(request)
puts response.read_body
{
  "displayOrder": 2,
  "fieldType": "select",
  "formField": true,
  "groupName": "contactinformation",
  "hasUniqueValue": false,
  "hidden": false,
  "label": "My Contact Property",
  "modificationMetadata": {
    "archivable": true,
    "readOnlyDefinition": false,
    "readOnlyOptions": false,
    "readOnlyValue": false
  },
  "name": "my_contact_property",
  "options": [
    {
      "description": "Choice number one",
      "displayOrder": 1,
      "hidden": false,
      "label": "Option A",
      "value": "A"
    },
    {
      "description": "Choice number two",
      "displayOrder": 2,
      "hidden": false,
      "label": "Option B",
      "value": "B"
    }
  ],
  "type": "enumeration"
}
{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

Supported products

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
objectType
string
required
​
propertyName
string
required

Body

application/json
​
calculationFormula
string

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

​
currencyPropertyName
string
​
description
string

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

​
displayOrder
integer<int32>

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

​
fieldType
enum<string>

Controls how the property appears in HubSpot.

Available options:
booleancheckbox,
calculation_equation,
checkbox,
date,
file,
html,
number,
phonenumber,
radio,
select,
text,
textarea
​
formField
boolean

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

​
groupName
string

The name of the property group the property belongs to.

​
hidden
boolean

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

​
label
string

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

​
numberDisplayHint
enum<string>
Available options:
currency,
duration,
formatted,
percentage,
probability,
unformatted
​
options
object[]

A list of valid options for the property.

​
showCurrencySymbol
boolean
​
textDisplayHint
enum<string>
Available options:
domain_name,
email,
ip_address,
multi_line,
phone_number,
physical_address,
postal_code,
unformatted_single_line
​
type
enum<string>

The data type of the property.

Available options:
bool,
date,
datetime,
enumeration,
number,
phone_number,
string

Response

successful operation

A HubSpot property

​
description
string
required

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

​
fieldType
string
required

Controls how the property appears in HubSpot.

​
groupName
string
required

The name of the property group the property belongs to.

​
label
string
required

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

​
name
string
required

The internal property name, which must be used when referencing the property via the API.

​
options
object[]
required

A list of valid options for the property. This field is required for enumerated properties, but will be empty for other property types.

​
type
string
required

The property data type.

​
archived
boolean

Whether or not the property is archived.

​
archivedAt
string<date-time>

When the property was archived.

​
calculated
boolean

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

​
calculationFormula
string

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

​
createdAt
string<date-time>

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

​
createdUserId
string

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.

​
currencyPropertyName
string

The name of the related currency property.

​
dataSensitivity
enum<string>

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

Available options:
highly_sensitive,
non_sensitive,
sensitive
​
dateDisplayHint
enum<string>

Indicates how date values should be displayed, with options such as 'absolute', 'absolute_with_relative', 'time_since', or 'time_until'.

Available options:
absolute,
absolute_with_relative,
time_since,
time_until
​
displayOrder
integer<int32>

Properties are shown in order, starting with the lowest positive integer value.

​
externalOptions
boolean

For default properties, true indicates that the options are stored externally to the property settings.

​
formField
boolean

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

​
hasUniqueValue
boolean

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

​
hidden
boolean

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

Example:

false

​
hubspotDefined
boolean

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

​
modificationMetadata
object
​
numberDisplayHint
enum<string>

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

Available options:
currency,
duration,
formatted,
percentage,
probability,
unformatted
​
referencedObjectType
string

If this property is related to other object(s), they'll be listed here.

​
sensitiveDataCategories
string[]

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

​
showCurrencySymbol
boolean

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

​
textDisplayHint
enum<string>

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".

Available options:
domain_name,
email,
ip_address,
multi_line,
phone_number,
physical_address,
postal_code,
unformatted_single_line
​
updatedAt
string<date-time>

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

​
updatedUserId
string

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.

Last modified on March 30, 2026