Saltar al contenido principal
POST
/
crm-object-schemas
/
v3
/
schemas
Crear un nuevo esquema de objeto personalizado.
curl --request POST \
  --url https://api.hubapi.com/crm-object-schemas/v3/schemas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "associatedObjects": [
    "CONTACT"
  ],
  "labels": {
    "plural": "My objects",
    "singular": "My object"
  },
  "metaType": "PORTAL_SPECIFIC",
  "name": "my_object",
  "primaryDisplayProperty": "my_object_property",
  "properties": [
    {
      "isPrimaryDisplayLabel": true,
      "label": "My object property",
      "name": "my_object_property"
    }
  ],
  "requiredProperties": [
    "my_object_property"
  ]
}
'
{
  "associations": [
    {
      "fromObjectTypeId": "2-123456",
      "id": "123",
      "name": "my_object_to_contact",
      "toObjectTypeId": "0-1"
    }
  ],
  "createdAt": "2020-02-20T18:07:11.390Z",
  "fullyQualifiedName": "p7878787_my_object\"",
  "id": "123456",
  "labels": {
    "plural": "My objects",
    "singular": "My object"
  },
  "metaType": "PORTAL_SPECIFIC",
  "name": "my_object",
  "primaryDisplayProperty": "my_object_property",
  "properties": [
    {
      "archived": false,
      "calculated": false,
      "createdAt": "2020-02-20T18:07:11.802Z",
      "displayOrder": -1,
      "externalOptions": false,
      "fieldType": "text",
      "groupName": "my_object_information",
      "hasUniqueValue": false,
      "label": "My object property",
      "name": "my_object_property",
      "type": "string",
      "updatedAt": "2020-02-20T18:07:11.802Z"
    }
  ],
  "requiredProperties": [
    "my_object_property"
  ],
  "searchableProperties": [
    "my_object_property"
  ],
  "updatedAt": "2020-02-20T18:09:07.555Z"
}
Productos compatibles
Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing HubEnterprise
Sales HubSales HubEnterprise
Service HubService HubEnterprise
Content HubContent HubEnterprise

Autorizaciones

Authorization
string
header
requerido

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

Cuerpo

application/json

Object schema definition, including properties and associations.

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

associatedObjects
string[]
requerido

Asociaciones definidas para este tipo de objeto.

labels
object
requerido

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

Ejemplo:
{
"plural": "My objects",
"singular": "My object"
}
name
string
requerido

Un nombre único para este objeto. Solo para uso interno.

properties
object[]
requerido

Propiedades definidas para este tipo de objeto.

requiredProperties
string[]
requerido

Los nombres de las propiedades que deben ser obligatorias cuando se cree un objeto de este tipo.

allowsSensitiveProperties
boolean

Determina si el tipo de objeto puede incluir propiedades marcadas como sensibles.

description
string

Una breve explicación del tipo de objeto.

primaryDisplayProperty
string

El nombre de la propiedad principal de este objeto. Se mostrará como principal en la página de registro de HubSpot para este tipo de objeto.

searchableProperties
string[]

Los nombres de las propiedades que serán indexadas para este tipo de objeto en la búsqueda de productos de HubSpot.

secondaryDisplayProperties
string[]

Los nombres de las propiedades secundarias de este objeto. Se mostrarán como secundarias en la página de registro de HubSpot para este tipo de objeto.

Respuesta

successful operation

Defines an object schema, including its properties and associations.

associations
object[]
requerido

Asociaciones definidas para un tipo de objeto determinado.

id
string
requerido

Un ID único para este tipo de objeto. Se definirá como {meta-type}-{unique ID}.

labels
object
requerido

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

Ejemplo:
{
"plural": "My objects",
"singular": "My object"
}
name
string
requerido

Un nombre único para este objeto. Solo para uso interno.

properties
object[]
requerido

Propiedades definidas para este tipo de objeto.

requiredProperties
string[]
requerido

Los nombres de las propiedades que deben ser obligatorias cuando se cree un objeto de este tipo.

allowsSensitiveProperties
boolean
archived
boolean
createdAt
string<date-time>

Cuando se creó el tipo de objeto.

createdByUserId
integer<int32>
description
string
fullyQualifiedName
string

Un ID único asignado para el objeto, que incluye el ID del portal y el nombre del objeto.

objectTypeId
string
primaryDisplayProperty
string

El nombre de la propiedad principal de este objeto. Se mostrará como principal en la página de registro de HubSpot para este tipo de objeto.

searchableProperties
string[]

Los nombres de las propiedades que serán indexadas para este tipo de objeto en la búsqueda de productos de HubSpot.

secondaryDisplayProperties
string[]

Los nombres de las propiedades secundarias de este objeto. Se mostrarán como secundarias en la página de registro de HubSpot para este tipo de objeto.

updatedAt
string<date-time>

Cuando se actualizó por última vez el tipo de objeto.

updatedByUserId
integer<int32>
Last modified on January 23, 2026