Update a property

Mettre à jour une propriété

curl --request PATCH \
  --url https://api.hubapi.com/crm/properties/2026-09/{objectType}/{propertyName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "calculationFormula": "<string>",
  "currencyPropertyName": "<string>",
  "description": "<string>",
  "displayOrder": 123,
  "formField": true,
  "groupName": "<string>",
  "hidden": true,
  "label": "<string>",
  "options": [
    {
      "displayOrder": 123,
      "hidden": true,
      "label": "<string>",
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "showCurrencySymbol": true
}
'

import requests

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

payload = {
    "calculationFormula": "<string>",
    "currencyPropertyName": "<string>",
    "description": "<string>",
    "displayOrder": 123,
    "formField": True,
    "groupName": "<string>",
    "hidden": True,
    "label": "<string>",
    "options": [
        {
            "displayOrder": 123,
            "hidden": True,
            "label": "<string>",
            "value": "<string>",
            "description": "<string>"
        }
    ],
    "showCurrencySymbol": True
}
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({
    calculationFormula: '<string>',
    currencyPropertyName: '<string>',
    description: '<string>',
    displayOrder: 123,
    formField: true,
    groupName: '<string>',
    hidden: true,
    label: '<string>',
    options: [
      {
        displayOrder: 123,
        hidden: true,
        label: '<string>',
        value: '<string>',
        description: '<string>'
      }
    ],
    showCurrencySymbol: true
  })
};

fetch('https://api.hubapi.com/crm/properties/2026-09/{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/properties/2026-09/{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([
    'calculationFormula' => '<string>',
    'currencyPropertyName' => '<string>',
    'description' => '<string>',
    'displayOrder' => 123,
    'formField' => true,
    'groupName' => '<string>',
    'hidden' => true,
    'label' => '<string>',
    'options' => [
        [
                'displayOrder' => 123,
                'hidden' => true,
                'label' => '<string>',
                'value' => '<string>',
                'description' => '<string>'
        ]
    ],
    'showCurrencySymbol' => true
  ]),
  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/properties/2026-09/{objectType}/{propertyName}"

	payload := strings.NewReader("{\n  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"formField\": true,\n  \"groupName\": \"<string>\",\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"showCurrencySymbol\": true\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/properties/2026-09/{objectType}/{propertyName}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"formField\": true,\n  \"groupName\": \"<string>\",\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"showCurrencySymbol\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/crm/properties/2026-09/{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  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"formField\": true,\n  \"groupName\": \"<string>\",\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"showCurrencySymbol\": true\n}"

response = http.request(request)
puts response.read_body

{
  "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,
  "textDisplayHint": "domain_name",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedUserId": "<string>"
}

{
  "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"
  }
}

PATCH

crm

properties

2026-09

{objectType}

{propertyName}

Mettre à jour une propriété

curl --request PATCH \
  --url https://api.hubapi.com/crm/properties/2026-09/{objectType}/{propertyName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "calculationFormula": "<string>",
  "currencyPropertyName": "<string>",
  "description": "<string>",
  "displayOrder": 123,
  "formField": true,
  "groupName": "<string>",
  "hidden": true,
  "label": "<string>",
  "options": [
    {
      "displayOrder": 123,
      "hidden": true,
      "label": "<string>",
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "showCurrencySymbol": true
}
'

import requests

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

payload = {
    "calculationFormula": "<string>",
    "currencyPropertyName": "<string>",
    "description": "<string>",
    "displayOrder": 123,
    "formField": True,
    "groupName": "<string>",
    "hidden": True,
    "label": "<string>",
    "options": [
        {
            "displayOrder": 123,
            "hidden": True,
            "label": "<string>",
            "value": "<string>",
            "description": "<string>"
        }
    ],
    "showCurrencySymbol": True
}
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({
    calculationFormula: '<string>',
    currencyPropertyName: '<string>',
    description: '<string>',
    displayOrder: 123,
    formField: true,
    groupName: '<string>',
    hidden: true,
    label: '<string>',
    options: [
      {
        displayOrder: 123,
        hidden: true,
        label: '<string>',
        value: '<string>',
        description: '<string>'
      }
    ],
    showCurrencySymbol: true
  })
};

fetch('https://api.hubapi.com/crm/properties/2026-09/{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/properties/2026-09/{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([
    'calculationFormula' => '<string>',
    'currencyPropertyName' => '<string>',
    'description' => '<string>',
    'displayOrder' => 123,
    'formField' => true,
    'groupName' => '<string>',
    'hidden' => true,
    'label' => '<string>',
    'options' => [
        [
                'displayOrder' => 123,
                'hidden' => true,
                'label' => '<string>',
                'value' => '<string>',
                'description' => '<string>'
        ]
    ],
    'showCurrencySymbol' => true
  ]),
  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/properties/2026-09/{objectType}/{propertyName}"

	payload := strings.NewReader("{\n  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"formField\": true,\n  \"groupName\": \"<string>\",\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"showCurrencySymbol\": true\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/properties/2026-09/{objectType}/{propertyName}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"formField\": true,\n  \"groupName\": \"<string>\",\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"showCurrencySymbol\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/crm/properties/2026-09/{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  \"calculationFormula\": \"<string>\",\n  \"currencyPropertyName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"displayOrder\": 123,\n  \"formField\": true,\n  \"groupName\": \"<string>\",\n  \"hidden\": true,\n  \"label\": \"<string>\",\n  \"options\": [\n    {\n      \"displayOrder\": 123,\n      \"hidden\": true,\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"showCurrencySymbol\": true\n}"

response = http.request(request)
puts response.read_body

{
  "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,
  "textDisplayHint": "domain_name",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedUserId": "<string>"
}

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

Required Scopes

Autorisations

Authorization

string

header

requis

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

Paramètres de chemin

objectType

string

requis

Le type d'objet pour lequel la propriété est mise à jour, tel que les contacts, les entreprises ou les transactions.

propertyName

string

requis

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

Corps

application/json

calculationFormula

string

Cela représente une formule utilisée pour calculer une propriété calculée.

currencyPropertyName

string

Chaîne spécifiant le nom de la propriété qui contient les informations de devise, applicable lorsque showCurrencySymbol est vrai.

description

string

Une description de la propriété qui sera affichée comme texte d'aide dans HubSpot.

displayOrder

integer<int32>

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.

fieldType

enum<string>

Contrôle la façon dont la propriété apparaît dans HubSpot.

Options disponibles:

booleancheckbox,

calculation_equation,

checkbox,

date,

file,

html,

number,

phonenumber,

radio,

select,

text,

textarea

formField

boolean

Si la propriété peut être utilisée dans un formulaire HubSpot ou non.

groupName

string

Le nom du groupe de propriétés auquel appartient la propriété.

hidden

boolean

Si vrai, la propriété ne sera pas visible et ne pourra pas être utilisée dans HubSpot.

label

string

Un libellé de propriété qui sera affichée dans HubSpot lisible par les personnes.

numberDisplayHint

enum<string>

Une chaîne fournissant une indication pour l'affichage des valeurs numériques. Les valeurs valides incluent « unformatted », « formatted », « currency », « percentage », « duration » et « probability ».

Options disponibles:

currency,

duration,

formatted,

percentage,

probability,

unformatted

options

object[]

Une liste d'options valides pour la propriété.

Show child attributes

showCurrencySymbol

boolean

Un booléen indiquant s'il faut afficher un symbole monétaire pour les champs numériques formatés en tant que devise.

textDisplayHint

enum<string>

Une chaîne fournissant une indication pour l'affichage des valeurs de 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>

Le type de données de la propriété.

Options disponibles:

bool,

date,

datetime,

enumeration,

number,

phone_number,

string

Réponse

successful operation

Propriété HubSpot

description

string

requis

Une description de la propriété qui sera affichée comme texte d'aide dans HubSpot.

fieldType

string

requis

Contrôle la façon dont la propriété apparaît dans HubSpot.

groupName

string

requis

Le nom du groupe de propriétés auquel appartient la propriété.

label

string

requis

Un libellé de propriété qui sera affichée dans HubSpot lisible par les personnes.

name

string

requis

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.

options

object[]

requis

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

type

string

requis

Le type de données de la propriété.

archived

boolean

Si la propriété est archivée ou non.

archivedAt

string<date-time>

Moment où la propriété a été archivée

calculated

boolean

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.

calculationFormula

string

Cela représente une formule utilisée pour calculer une propriété calculée.

createdAt

string<date-time>

Date à laquelle la propriété a été créée, au format ISO 8601.

createdUserId

string

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.

currencyPropertyName

string

Le nom de la propriété de devise associée à cette propriété, le cas échéant.

dataSensitivity

enum<string>

Le niveau de sensibilité des données : les valeurs valides incluent « non_sensitive », « sensitive » et « highly_sensitive ».

Options disponibles:

highly_sensitive,

non_sensitive,

sensitive

dateDisplayHint

enum<string>

Indique comment les valeurs de date doivent être affichées, avec des options telles que « absolute », « absolute_with_relative », « time_since » ou « time_until ».

Options disponibles:

absolute,

absolute_with_relative,

time_since,

time_until

displayOrder

integer<int32>

Les propriétés sont affichées dans l'ordre croissant en partant de la valeur entière positive la plus basse.

externalOptions

boolean

Par défaut, vrai indique que les options sont stockées en dehors des paramètres de propriété.

formField

boolean

Si la propriété peut être utilisée dans un formulaire HubSpot ou non.

hasUniqueValue

boolean

Si la valeur de la propriété doit être unique ou non. Une fois définie, il n'est pas possible de le modifier.

hidden

boolean

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.

Exemple:

false

hubspotDefined

boolean

Cette valeur sera « vrai » pour les propriétés d'objet par défaut intégrées dans HubSpot.

modificationMetadata

object

Show child attributes

numberDisplayHint

enum<string>

Une indication pour l'affichage des propriétés numériques. Les valeurs valides incluent « unformatted », « formatted », « currency », « percentage », « duration » et « probability ».

Options disponibles:

currency,

duration,

formatted,

percentage,

probability,

unformatted

referencedObjectType

string

Si cette propriété est liée à un ou plusieurs autres objets, ils seront répertoriés ici.

sensitiveDataCategories

string[]

Un tableau de catégories indiquant la sensibilité des données contenues dans la propriété.

showCurrencySymbol

boolean

Si la propriété affiche ou non le symbole de la devise défini dans les paramètres du compte.

textDisplayHint

enum<string>

Une indication pour l'affichage des propriétés de 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

updatedAt

string<date-time>

L'horodatage du moment où la propriété a été mise à jour pour la dernière fois, au format ISO 8601.

updatedUserId

string

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.

Dernière modification le 6 octobre 2026

Compte et paramètres

Gestion des applications

Authentification

Automatisation

CMS

Préférences de communication

Conversations

CRM

Data Studio

Événements

Fichiers

Marketing

Rendez-vous

Chiffre d'affaires

Webhooks

Journal des webhooks

Autorisations

Paramètres de chemin

Corps

Réponse