Saltar al contenido principal
PATCH
/
crm-object-schemas
/
v3
/
schemas
/
{objectType}
Actualizar el esquema de un objeto personalizado específico.
curl --request PATCH \
  --url https://api.hubapi.com/crm-object-schemas/v3/schemas/{objectType} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "primaryDisplayProperty": "my_object_property",
  "requiredProperties": [
    "my_object_property"
  ],
  "searchableProperties": [
    "my_object_property"
  ]
}
'
{
  "createdAt": "2020-02-20T18:07:11.390Z",
  "id": "123456",
  "labels": {
    "plural": "My objects",
    "singular": "My object"
  },
  "metaType": "PORTAL_SPECIFIC",
  "name": "my_object",
  "portalId": 12345678,
  "primaryDisplayProperty": "my_object_property",
  "requiredProperties": [
    "my_object_property"
  ],
  "searchableProperties": [
    "my_object_property"
  ],
  "updatedAt": "2020-02-21T14:13:28.818002Z"
}
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.

Parámetros de ruta

​
objectType
string
requerido

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

Cuerpo

application/json

Attributes to update in your schema.

Defines attributes to update on an object type.

​
allowsSensitiveProperties
boolean

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

​
clearDescription
boolean

Indica si se debe borrar la descripción del tipo de objeto.

​
description
string

Una breve explicación del tipo de objeto.

​
labels
object

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

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

​
requiredProperties
string[]

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

​
restorable
boolean

Especifica si el tipo de objeto se puede restaurar después de eliminarse.

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

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

​
requiredProperties
string[]
requerido

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

​
allowsSensitiveProperties
boolean

Indica si el tipo de objeto permite propiedades que contienen datos sensibles.

​
archived
boolean

Indica si el tipo de objeto está archivado.

​
createdAt
string<date-time>

Cuando se creó el tipo de objeto.

​
description
string

Una descripción del tipo de objeto.

​
fullyQualifiedName
string

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

​
objectTypeId
string

Un identificador único para el tipo de objeto.

​
portalId
integer<int32>

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.

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

Last modified on January 23, 2026