Pular para o conteúdo principal
POST
/
crm-object-schemas
/
v3
/
schemas
cURL
curl --request POST \
  --url https://api.hubapi.com/crm-object-schemas/v3/schemas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my_object",
  "labels": {
    "singular": "My object",
    "plural": "My objects"
  },
  "primaryDisplayProperty": "my_object_property",
  "requiredProperties": [
    "my_object_property"
  ],
  "properties": [
    {
      "name": "my_object_property",
      "label": "My object property",
      "isPrimaryDisplayLabel": true
    }
  ],
  "associatedObjects": [
    "CONTACT"
  ],
  "metaType": "PORTAL_SPECIFIC"
}
'
{
  "id": "123456",
  "createdAt": "2020-02-20T18:07:11.390Z",
  "updatedAt": "2020-02-20T18:09:07.555Z",
  "properties": [
    {
      "updatedAt": "2020-02-20T18:07:11.802Z",
      "createdAt": "2020-02-20T18:07:11.802Z",
      "name": "my_object_property",
      "label": "My object property",
      "type": "string",
      "fieldType": "text",
      "groupName": "my_object_information",
      "displayOrder": -1,
      "calculated": false,
      "externalOptions": false,
      "archived": false,
      "hasUniqueValue": false
    }
  ],
  "associations": [
    {
      "id": "123",
      "fromObjectTypeId": "2-123456",
      "toObjectTypeId": "0-1",
      "name": "my_object_to_contact"
    }
  ],
  "labels": {
    "singular": "My object",
    "plural": "My objects"
  },
  "requiredProperties": [
    "my_object_property"
  ],
  "searchableProperties": [
    "my_object_property"
  ],
  "primaryDisplayProperty": "my_object_property",
  "metaType": "PORTAL_SPECIFIC",
  "fullyQualifiedName": "p7878787_my_object\"",
  "name": "my_object"
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubEnterprise
Sales HubSales HubEnterprise
Service HubService HubEnterprise
Content HubContent HubEnterprise

Autorizações

Authorization
string
header
obrigatório

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

Corpo

application/json

Object schema definition, including properties and associations.

Defines a new object type, its properties, and associations.

associatedObjects
string[]
obrigatório

Associações definidas para este tipo de objeto.

labels
object
obrigatório

Singular and plural labels for the object. Used in CRM display.

Exemplo:
{
"singular": "My object",
"plural": "My objects"
}
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.

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.

searchableProperties
string[]

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

secondaryDisplayProperties
string[]

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.

Resposta

successful operation

Defines an object schema, including its properties and associations.

associations
object[]
obrigatório

Associações definidas para um determinado tipo de 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

Singular and plural labels for the object. Used in CRM display.

Exemplo:
{
"singular": "My object",
"plural": "My objects"
}
name
string
obrigatório

Um nome exclusivo para o tipo de objeto do esquema.

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.

archived
boolean
createdAt
string<date-time>

Quando o esquema do objeto foi criado.

createdByUserId
integer<int32>
description
string
fullyQualifiedName
string

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

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

searchableProperties
string[]

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

secondaryDisplayProperties
string[]

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.

updatedAt
string<date-time>

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

updatedByUserId
integer<int32>
Last modified on August 31, 2025