Pular para o conteúdo principal
POST
/
crm-object-schemas
/
2026-03
/
schemas
Crie um novo esquema de objeto personalizado.
curl --request POST \
  --url https://api.hubapi.com/crm-object-schemas/2026-03/schemas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowsSensitiveProperties": true,
  "associatedObjects": [
    "<string>"
  ],
  "labels": {
    "plural": "<string>",
    "singular": "<string>"
  },
  "name": "<string>",
  "properties": [
    {
      "fieldType": "<string>",
      "label": "<string>",
      "name": "<string>",
      "type": "bool",
      "description": "<string>",
      "displayOrder": 123,
      "externalOptionsReferenceType": "<string>",
      "formField": true,
      "groupName": "<string>",
      "hasUniqueValue": true,
      "hidden": true,
      "numberDisplayHint": "currency",
      "optionSortStrategy": "ALPHABETICAL",
      "options": [
        {
          "displayOrder": 123,
          "hidden": true,
          "label": "<string>",
          "value": "<string>",
          "description": "<string>"
        }
      ],
      "referencedObjectType": "<string>",
      "searchableInGlobalSearch": true,
      "showCurrencySymbol": true,
      "textDisplayHint": "domain_name"
    }
  ],
  "requiredProperties": [
    "<string>"
  ],
  "searchableProperties": [
    "<string>"
  ],
  "secondaryDisplayProperties": [
    "<string>"
  ],
  "description": "<string>",
  "primaryDisplayProperty": "<string>"
}
'
{
  "allowsSensitiveProperties": true,
  "archived": true,
  "associations": [
    {
      "fromObjectTypeId": "<string>",
      "id": "<string>",
      "toObjectTypeId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "fullyQualifiedName": "<string>",
  "id": "<string>",
  "labels": {
    "plural": "<string>",
    "singular": "<string>"
  },
  "name": "<string>",
  "objectTypeId": "<string>",
  "properties": [
    {
      "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>"
    }
  ],
  "requiredProperties": [
    "<string>"
  ],
  "searchableProperties": [
    "<string>"
  ],
  "secondaryDisplayProperties": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "createdByUserId": 123,
  "description": "<string>",
  "primaryDisplayProperty": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedByUserId": 123
}

Supported products

Autorizações

Authorization
string
header
obrigatório

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

Corpo

application/json
allowsSensitiveProperties
boolean
obrigatório

Determina se o tipo de objeto pode incluir propriedades marcadas como confidenciais.

associatedObjects
string[]
obrigatório

Associações definidas para este tipo de objeto.

labels
object
obrigatório
name
string
obrigatório

Um nome exclusivo para este objeto. Apenas para uso interno.

properties
object[]
obrigatório

Propriedades definidas para este tipo de objeto.

requiredProperties
string[]
obrigatório

Os nomes das propriedades que devem ser obrigatórias ao criar um objeto deste tipo.

searchableProperties
string[]
obrigatório

Nomes das propriedades que serão indexadas para este tipo de objeto na pesquisa de produtos da HubSpot.

secondaryDisplayProperties
string[]
obrigatório

Os nomes das propriedades secundárias para este objeto. Serão exibidas como secundárias na página do registro do HubSpot para este tipo de objeto.

description
string

Uma breve explicação do tipo de objeto.

primaryDisplayProperty
string

O nome da propriedade principal para este objeto. Será exibido como principal na página de registro do HubSpot para este tipo de objeto.

Resposta

successful operation

allowsSensitiveProperties
boolean
obrigatório
archived
boolean
obrigatório
associations
object[]
obrigatório

Associações definidas para um determinado tipo de objeto.

fullyQualifiedName
string
obrigatório

Um ID exclusivo atribuído ao objeto, incluindo o ID do portal e o nome do objeto.

id
string
obrigatório

Um ID exclusivo para o tipo de objeto deste esquema. Será definido como {meta-type}-{unique ID}.

labels
object
obrigatório
name
string
obrigatório

Um nome exclusivo para o tipo de objeto do esquema.

objectTypeId
string
obrigatório
properties
object[]
obrigatório

Propriedades definidas para este tipo de objeto.

requiredProperties
string[]
obrigatório

Os nomes das propriedades que devem ser obrigatórias ao criar um objeto deste tipo.

searchableProperties
string[]
obrigatório

Nomes das propriedades que serão indexadas para este tipo de objeto na pesquisa de produtos da HubSpot.

secondaryDisplayProperties
string[]
obrigatório

Os nomes das propriedades secundárias para este objeto. Serão exibidas como secundárias na página do registro do HubSpot para este tipo de objeto.

createdAt
string<date-time>

Quando o esquema do objeto foi criado.

createdByUserId
integer<int32>
description
string
primaryDisplayProperty
string

O nome da propriedade principal para este objeto. Será exibido como principal na página de registro do HubSpot para este tipo de objeto.

updatedAt
string<date-time>

Quando o esquema do objeto foi atualizado pela última vez.

updatedByUserId
integer<int32>
Last modified on April 13, 2026