Skip to main content
POST
/
crm-object-schemas
/
v3
/
schemas
cURL
curl --request POST \
  --url https://api.hubapi.com/crm-object-schemas/v3/schemas \
  --header 'Content-Type: application/json' \
  --header 'private-app: <api-key>' \
  --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"
}
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

Authorizations

​
private-app
string
header
required

Body

application/json

Object schema definition, including properties and associations.

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

​
requiredProperties
string[]
required

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

​
name
string
required

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

​
associatedObjects
string[]
required

Asociaciones definidas para este tipo de objeto.

​
properties
object[]
required

Propiedades definidas para este tipo de objeto.

​
labels
object
required

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

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

​
searchableProperties
string[]

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

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

​
description
string

Response

successful operation

Defines an object schema, including its properties and associations.

​
associations
object[]
required

Asociaciones definidas para un tipo de objeto determinado.

​
labels
object
required

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

Example:
{
  "singular": "My object",
  "plural": "My objects"
}
​
requiredProperties
string[]
required

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

​
name
string
required

Un nombre único para el tipo de objeto del esquema.

​
id
string
required

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

​
properties
object[]
required

Propiedades definidas para este tipo de objeto.

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

​
createdByUserId
integer
​
objectTypeId
string
​
description
string
​
updatedByUserId
integer
​
fullyQualifiedName
string

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

​
archived
boolean
​
createdAt
string<date-time>

Cuando se creó el esquema de objetos.

​
searchableProperties
string[]

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

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

​
updatedAt
string<date-time>

Cuando se actualizó por última vez el esquema de objetos.