Account & Settings
Gerenciamento de aplicativo
Autenticação
Automação
CMS
Communication preferences
Conversas
CRM
Marketing
Scheduler
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,
"fieldType": "booleancheckbox",
"formField": true,
"groupName": "<string>",
"hidden": true,
"label": "<string>",
"numberDisplayHint": "currency",
"options": [
{
"displayOrder": 123,
"hidden": true,
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
],
"showCurrencySymbol": true,
"type": "bool"
}
'{
"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,
"updatedAt": "2023-11-07T05:31:56Z",
"updatedUserId": "<string>"
}Update a property
Realize uma atualização parcial de uma propriedade identificada por . Os campos fornecidos serão substituídos.
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,
"fieldType": "booleancheckbox",
"formField": true,
"groupName": "<string>",
"hidden": true,
"label": "<string>",
"numberDisplayHint": "currency",
"options": [
{
"displayOrder": 123,
"hidden": true,
"label": "<string>",
"value": "<string>",
"description": "<string>"
}
],
"showCurrencySymbol": true,
"type": "bool"
}
'{
"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,
"updatedAt": "2023-11-07T05:31:56Z",
"updatedUserId": "<string>"
}Supported products
Supported products
Required Scopes
Required Scopes
Autorizações
The access token received from the authorization server in the OAuth 2.0 flow.
Corpo
Representa uma fórmula que é usada para calcular uma propriedade de cálculo.
Uma descrição da propriedade que será exibida como texto de ajuda no HubSpot.
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.
Controla como a propriedade aparece no HubSpot.
booleancheckbox, calculation_equation, checkbox, date, file, html, number, phonenumber, radio, select, text, textarea Se a propriedade pode ser usada em um formulário da HubSpot.
O nome do grupo de propriedades ao qual a propriedade pertence.
Se verdadeiro, a propriedade não será visível e não poderá ser usada no HubSpot.
Um rótulo de propriedade legível por humanos que será exibido no HubSpot.
currency, duration, formatted, percentage, probability, unformatted Uma lista de opções válidas para a propriedade.
Show child attributes
Show child attributes
O tipo de dados da propriedade.
bool, date, datetime, enumeration, number, phone_number, string Resposta
successful operation
Propriedade do HubSpot
Uma descrição da propriedade que será exibida como texto de ajuda no HubSpot.
Controla como a propriedade aparece no HubSpot.
O nome do grupo de propriedades ao qual a propriedade pertence.
Um rótulo de propriedade legível por humanos que será exibido no HubSpot.
O nome interno da propriedade, que deve ser usado ao referenciá-la via API.
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.
Show child attributes
Show child attributes
O tipo de dados da propriedade.
Se a propriedade está arquivada ou não.
Quando a propriedade foi arquivada.
Para propriedades padrão, verdadeiro indica que a propriedade é calculada por um processo da HubSpot. Não tem efeito para propriedades personalizadas.
Representa uma fórmula que é usada para calcular uma propriedade de cálculo.
A data e hora em que a propriedade foi criada, no formato ISO 8601.
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.
O nome da propriedade de moeda relacionada.
Indica o nível de sensibilidade da propriedade, como "non_sensitive", "sensitive" ou "highly_sensitive".
highly_sensitive, non_sensitive, sensitive Indica como os valores de data devem ser exibidos, com opções como "absolute", "absolute_with_relative", "time_since" ou "time_until".
absolute, absolute_with_relative, time_since, time_until As propriedades são mostradas em ordem, começando com o menor valor inteiro positivo.
Para propriedades padrão, verdadeiro indica que as opções são armazenadas externamente às configurações da propriedade.
Se a propriedade pode ser usada em um formulário da HubSpot.
Se o valor da propriedade deve ser exclusivo ou não. Uma vez definido, isso não pode ser alterado.
Se a propriedade será ou não ocultada da interface do HubSpot. É recomendado definir como falso para propriedades personalizadas.
false
Será verdadeiro para propriedades de objeto padrão incorporadas ao HubSpot.
Show child attributes
Show child attributes
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".
currency, duration, formatted, percentage, probability, unformatted Se esta propriedade estiver relacionada a outro(s) objeto(s), ele(s) será(ão) listado(s) aqui.
Quando sensitiveData é verdadeiro, lista o tipo de dados confidenciais contidos na propriedade (por exemplo, "HIPAA").
Se a propriedade exibirá ou não o símbolo da moeda definido nas configurações da conta.
A data e hora em que a propriedade foi atualizada pela última vez, no formato ISO 8601.
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.