Pular para o conteúdo principal
PATCH
/
crm-object-schemas
/
v3
/
schemas
/
{objectType}
Atualize o esquema de um objeto personalizado especificado.
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"
}
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.

Parâmetros de caminho

​
objectType
string
obrigatório

Nome completo ou ID do tipo de objeto do seu esquema.

Corpo

application/json

Attributes to update in your schema.

Defines attributes to update on an object type.

​
allowsSensitiveProperties
boolean

Determina se o tipo de objeto pode incluir propriedades marcadas como confidenciais.

​
clearDescription
boolean

Indica se a descrição do tipo de objeto deve ser apagada.

​
description
string

Uma breve explicação do tipo de objeto.

​
labels
object

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

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

​
requiredProperties
string[]

Os nomes das propriedades que devem ser obrigatórias ao criar um objeto deste tipo.

​
restorable
boolean

Especifica se o tipo de objeto pode ser restaurado após ser excluído.

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

​
id
string
obrigatório

Um ID exclusivo para este tipo de objeto. Será definido como {meta-type}-{unique ID}.

​
labels
object
obrigatório

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

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

Um nome exclusivo para este objeto. Apenas para uso interno.

​
requiredProperties
string[]
obrigatório

Os nomes das propriedades que devem ser obrigatórias ao criar um objeto deste tipo.

​
allowsSensitiveProperties
boolean

Indica se o tipo de objeto permite propriedades que contêm dados confidenciais.

​
archived
boolean

Indica se o tipo de objeto está arquivado.

​
createdAt
string<date-time>

Quando o tipo de objeto foi criado.

​
description
string

Uma descrição do tipo de objeto.

​
fullyQualifiedName
string

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

​
objectTypeId
string

Um identificador exclusivo para o tipo de objeto.

​
portalId
integer<int32>

O ID da conta ao qual este objeto é específico.

​
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 tipo de objeto foi atualizado pela última vez.

Last modified on January 23, 2026