Pular para o conteúdo principal
POST
/
crm
/
v3
/
properties
/
{objectType}
Criar uma propriedade
curl --request POST \
  --url https://api.hubapi.com/crm/v3/properties/{objectType} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayOrder": 2,
  "fieldType": "select",
  "formField": true,
  "groupName": "contactinformation",
  "hasUniqueValue": false,
  "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"
}
'
{
  "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"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Grátis
Sales HubSales Hub -Grátis
Service HubService Hub -Grátis
Content HubContent Hub -Grátis

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

O tipo de objeto para o qual uma nova propriedade está sendo criada.

Corpo

application/json
​
fieldType
enum<string>
obrigatório

Controla como a propriedade aparece no HubSpot.

Opções disponíveis:
booleancheckbox,
calculation_equation,
checkbox,
date,
file,
html,
number,
phonenumber,
radio,
select,
text,
textarea
​
groupName
string
obrigatório

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

​
label
string
obrigatório

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

​
name
string
obrigatório

O nome da propriedade a ser lida ou modificada.

​
type
enum<string>
obrigatório

O tipo de dados da propriedade.

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

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

​
dataSensitivity
enum<string>

Indica o nível de confidencialidade da propriedade, com as opções: highly_sensitive, non_sensitive ou sensitive.

Opções disponíveis:
highly_sensitive,
non_sensitive,
sensitive
​
description
string

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

​
displayOrder
integer<int32>

Os grupos de propriedades são exibidos em ordem começando com o menor valor inteiro positivo. Valores de -1 farão com que o grupo de propriedades seja exibido após os valores positivos.

​
externalOptions
boolean

Aplica-se apenas a propriedades do tipo "enumeração". Deve ser definido como verdadeiro em conjunto com um "referencedObjectType" igual a "OWNER". Caso contrário, será falso.

​
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 verdadeiro, a propriedade não será visível e não poderá ser usada no HubSpot.

​
options
object[]

Uma lista de opções válidas para a propriedade. Este campo é obrigatório para propriedades enumeradas.

​
referencedObjectType
string

Deve ser definido como "OWNER" quando "externalOptions" for verdadeiro, o que faz com que a propriedade extraia de forma dinâmica os valores das opções dos usuários atuais do HubSpot.

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 legível por humanos que será exibido no HubSpot.

​
name
string
obrigatório

O nome da propriedade a ser lida ou modificada.

​
options
object[]
obrigatório

Uma lista de opções válidas para a propriedade. Este campo é obrigatório para propriedades enumeradas.

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

​
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>

Os grupos de propriedades são exibidos em ordem começando com o menor valor inteiro positivo. Valores de -1 farão com que o grupo de propriedades seja exibido após os valores positivos.

​
externalOptions
boolean

Aplica-se apenas a propriedades do tipo "enumeração". Deve ser definido como verdadeiro em conjunto com um "referencedObjectType" igual a "OWNER". Caso contrário, será falso.

​
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 verdadeiro, a propriedade não será visível e não poderá ser usada no HubSpot.

Exemplo:

false

​
hubspotDefined
boolean

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

​
modificationMetadata
object
​
referencedObjectType
string

Deve ser definido como "OWNER" quando "externalOptions" for verdadeiro, o que faz com que a propriedade extraia de forma dinâmica os valores das opções dos usuários atuais do HubSpot.

​
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 March 5, 2026