Zum Hauptinhalt springen
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"
}'
{
  "location": "<string>",
  "createdResourceId": "<string>",
  "entity": {
    "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 -Starter
Esta API requer um dos seguintes escopos:
crm.objects.carts.write
crm.objects.orders.write
crm.objects.users.write
crm.pipelines.orders.write
crm.schemas.appointments.write
crm.schemas.carts.write
crm.schemas.commercepayments.write
crm.schemas.companies.write
crm.schemas.contacts.write
crm.schemas.courses.write
crm.schemas.deals.write
crm.schemas.invoices.write
crm.schemas.listings.write
crm.schemas.orders.write
crm.schemas.services.write
crm.schemas.subscriptions.write
e-commerce
tickets
tickets.highly_sensitive.v2
tickets.sensitive.v2

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
objectType
string
required

Body

application/json
​
label
string
required

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

Example:

"My Contact Property"

​
type
enum<string>
required

O tipo de dados da propriedade.

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

"enumeration"

​
groupName
string
required

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

Example:

"contactinformation"

​
name
string
required

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

​
fieldType
enum<string>
required

Controla como a propriedade aparece no HubSpot.

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

"select"

​
hidden
boolean

Se verdadeiro, a opção não será exibida em formulários, bots ou páginas de agendamento de reuniões. Compatível com propriedades de enumeração de contato, empresa, ticket e objeto personalizado.

​
displayOrder
integer

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.

Example:

2

​
description
string

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

​
formField
boolean

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

​
dataSensitivity
enum<string>
Available options:
non_sensitive,
sensitive,
highly_sensitive
​
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.

​
options
object[]

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

Example:

"[{\"label\":\"Option A\",\"value\":\"A\",\"hidden\":false,\"description\":\"Choice number one\",\"displayOrder\":1},{\"label\":\"Option B\",\"value\":\"B\",\"hidden\":false,\"description\":\"Choice number two\",\"displayOrder\":2}]"

​
calculationFormula
string

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

​
hasUniqueValue
boolean

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

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

Response

successful operation

​
createdResourceId
string
required
​
entity
object
required

A HubSpot property

Example:
{
  "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"
}
​
location
string
⌘I