Skip to main content
PATCH
/
crm-object-schemas
/
v3
/
schemas
/
{objectType}
cURL
curl --request PATCH \
  --url https://api.hubapi.com/crm-object-schemas/v3/schemas/{objectType} \
  --header 'Content-Type: application/json' \
  --header 'private-app: <api-key>' \
  --data '{
  "primaryDisplayProperty": "my_object_property",
  "requiredProperties": [
    "my_object_property"
  ],
  "searchableProperties": [
    "my_object_property"
  ]
}'
{
  "id": "123456",
  "createdAt": "2020-02-20T18:07:11.390Z",
  "updatedAt": "2020-02-21T14:13:28.818002Z",
  "labels": {
    "singular": "My object",
    "plural": "My objects"
  },
  "requiredProperties": [
    "my_object_property"
  ],
  "searchableProperties": [
    "my_object_property"
  ],
  "primaryDisplayProperty": "my_object_property",
  "portalId": 12345678,
  "metaType": "PORTAL_SPECIFIC",
  "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

Path Parameters

​
objectType
string
required

Nombre completamente calificado o ID del tipo de objeto de tu esquema.

Body

application/json

Attributes to update in your schema.

Defines attributes to update on an object type.

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

​
requiredProperties
string[]

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

​
searchableProperties
string[]

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

​
clearDescription
boolean
​
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
​
restorable
boolean
​
labels
object

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

Example:
{
  "singular": "My object",
  "plural": "My objects"
}

Response

successful operation

Defines an object type.

​
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 este objeto. Solo para uso interno.

​
id
string
required

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

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

​
objectTypeId
string
​
description
string
​
fullyQualifiedName
string
​
archived
boolean
​
createdAt
string<date-time>

Cuando se creó el 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.

​
portalId
integer

El ID de la cuenta de la que este tipo de objeto es específico.

​
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 tipo de objeto.