Pular para o conteúdo principal
PATCH
/
crm
/
properties
/
2026-03
/
{objectType}
/
{propertyName}
Atualizar uma propriedade
curl --request PATCH \
  --url https://api.hubapi.com/crm/properties/2026-03/{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
}
'
{
  "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>",
  "displayOrder": 123,
  "externalOptions": true,
  "formField": true,
  "hasUniqueValue": true,
  "hidden": false,
  "hubspotDefined": true,
  "modificationMetadata": {
    "archivable": true,
    "readOnlyDefinition": true,
    "readOnlyValue": true,
    "readOnlyOptions": true
  },
  "referencedObjectType": "<string>",
  "sensitiveDataCategories": [
    "<string>"
  ],
  "showCurrencySymbol": true,
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedUserId": "<string>"
}

Supported products

Autorizações

​
Authorization
string
header
obrigatório

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

Parâmetros de caminho

​
objectType
string
obrigatório
​
propertyName
string
obrigatório

Corpo

application/json
​
calculationFormula
string

Representa uma fórmula que é usada para calcular uma propriedade de cálculo.

​
currencyPropertyName
string
​
description
string

Uma descrição da propriedade que será exibida como texto de ajuda no HubSpot.

​
displayOrder
integer<int32>

As propriedades são exibidas em ordem começando com o menor valor inteiro positivo. Valores de -1 farão com que a propriedade seja exibida após os valores positivos.

​
fieldType
enum<string>

Controla como a propriedade aparece no HubSpot.

Opções disponíveis:
booleancheckbox,
calculation_equation,
checkbox,
date,
file,
html,
number,
phonenumber,
radio,
select,
text,
textarea
​
formField
boolean

Se a propriedade pode ser usada em um formulário da HubSpot.

​
groupName
string

O nome do grupo de propriedades ao qual a propriedade pertence.

​
hidden
boolean

Se verdadeiro, a propriedade não será visível e não poderá ser usada no HubSpot.

​
label
string

Um rótulo de propriedade legível por humanos que será exibido no HubSpot.

​
numberDisplayHint
enum<string>
Opções disponíveis:
currency,
duration,
formatted,
percentage,
probability,
unformatted
​
options
object[]

Uma lista de opções válidas para a propriedade.

​
showCurrencySymbol
boolean
​
type
enum<string>

O tipo de dados da propriedade.

Opções disponíveis:
bool,
date,
datetime,
enumeration,
number,
phone_number,
string

Resposta

successful operation

Propriedade do HubSpot

​
description
string
obrigatório

Uma descrição da propriedade que será exibida como texto de ajuda no HubSpot.

​
fieldType
string
obrigatório

Controla como a propriedade aparece no HubSpot.

​
groupName
string
obrigatório

O nome do grupo de propriedades ao qual a propriedade pertence.

​
label
string
obrigatório

Um rótulo de propriedade legível por humanos que será exibido no HubSpot.

​
name
string
obrigatório

O nome interno da propriedade, que deve ser usado ao referenciá-la via API.

​
options
object[]
obrigatório

Uma lista de opções válidas para a propriedade. Este campo é obrigatório para propriedades enumeradas, mas estará vazio para outros tipos de propriedade.

​
type
string
obrigatório

O tipo de dados da propriedade.

​
archived
boolean

Se a propriedade está arquivada ou não.

​
archivedAt
string<date-time>

Quando a propriedade foi arquivada.

​
calculated
boolean

Para propriedades padrão, verdadeiro indica que a propriedade é calculada por um processo da HubSpot. Não tem efeito para propriedades personalizadas.

​
calculationFormula
string

Representa uma fórmula que é usada para calcular uma propriedade de cálculo.

​
createdAt
string<date-time>

A data e hora em que a propriedade foi criada, no formato ISO 8601.

​
createdUserId
string

O ID de usuário interno do usuário que criou a propriedade no HubSpot. Este campo pode não existir se a propriedade foi criada fora do HubSpot.

​
currencyPropertyName
string

O nome da propriedade de moeda relacionada.

​
dataSensitivity
enum<string>

Indica o nível de sensibilidade da propriedade, como "non_sensitive", "sensitive" ou "highly_sensitive".

Opções disponíveis:
highly_sensitive,
non_sensitive,
sensitive
​
dateDisplayHint
enum<string>

Indica como os valores de data devem ser exibidos, com opções como "absolute", "absolute_with_relative", "time_since" ou "time_until".

Opções disponíveis:
absolute,
absolute_with_relative,
time_since,
time_until
​
displayOrder
integer<int32>

As propriedades são mostradas em ordem, começando com o menor valor inteiro positivo.

​
externalOptions
boolean

Para propriedades padrão, verdadeiro indica que as opções são armazenadas externamente às configurações da propriedade.

​
formField
boolean

Se a propriedade pode ser usada em um formulário da HubSpot.

​
hasUniqueValue
boolean

Se o valor da propriedade deve ser exclusivo ou não. Uma vez definido, isso não pode ser alterado.

​
hidden
boolean

Se a propriedade será ou não ocultada da interface do HubSpot. É recomendado definir como falso para propriedades personalizadas.

Exemplo:

false

​
hubspotDefined
boolean

Será verdadeiro para propriedades de objeto padrão incorporadas ao HubSpot.

​
modificationMetadata
object
​
numberDisplayHint
enum<string>

Dica de como uma propriedade numérica é exibida e validada na interface do HubSpot. Pode ser: "sem formato", "formatado", "moeda", "porcentagem", "duração" ou "probabilidade".

Opções disponíveis:
currency,
duration,
formatted,
percentage,
probability,
unformatted
​
referencedObjectType
string

Se esta propriedade estiver relacionada a outro(s) objeto(s), ele(s) será(ão) listado(s) aqui.

​
sensitiveDataCategories
string[]

Quando sensitiveData é verdadeiro, lista o tipo de dados confidenciais contidos na propriedade (por exemplo, "HIPAA").

​
showCurrencySymbol
boolean

Se a propriedade exibirá ou não o símbolo da moeda definido nas configurações da conta.

​
updatedAt
string<date-time>

A data e hora em que a propriedade foi atualizada pela última vez, no formato ISO 8601.

​
updatedUserId
string

O ID de usuário interno do usuário que atualizou a propriedade no HubSpot. Este campo pode não existir se a propriedade foi atualizada fora do HubSpot.

Last modified on April 13, 2026