Pular para o conteúdo principal
PATCH
/
crm-object-schemas
/
2026-03
/
schemas
/
{objectType}
Atualize o esquema de um objeto personalizado especificado.
curl --request PATCH \
  --url https://api.hubapi.com/crm-object-schemas/2026-03/schemas/{objectType} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clearDescription": true,
  "allowsSensitiveProperties": true,
  "description": "<string>",
  "labels": {
    "plural": "<string>",
    "singular": "<string>"
  },
  "primaryDisplayProperty": "<string>",
  "requiredProperties": [
    "<string>"
  ],
  "restorable": true,
  "searchableProperties": [
    "<string>"
  ],
  "secondaryDisplayProperties": [
    "<string>"
  ]
}
'
{
  "allowsSensitiveProperties": true,
  "archived": true,
  "fullyQualifiedName": "<string>",
  "id": "<string>",
  "labels": {
    "plural": "<string>",
    "singular": "<string>"
  },
  "name": "<string>",
  "objectTypeId": "<string>",
  "requiredProperties": [
    "<string>"
  ],
  "searchableProperties": [
    "<string>"
  ],
  "secondaryDisplayProperties": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "portalId": 123,
  "primaryDisplayProperty": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Supported products

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
clearDescription
boolean
obrigatório

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

allowsSensitiveProperties
boolean

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

description
string

Uma breve explicação do tipo de objeto.

labels
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

allowsSensitiveProperties
boolean
obrigatório

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

archived
boolean
obrigatório

Indica se o tipo de objeto está arquivado.

fullyQualifiedName
string
obrigatório

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

id
string
obrigatório

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

labels
object
obrigatório
name
string
obrigatório

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

objectTypeId
string
obrigatório

Um identificador exclusivo para o tipo de objeto.

requiredProperties
string[]
obrigatório

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

searchableProperties
string[]
obrigatório

Nomes das propriedades que serão indexadas para este tipo de objeto na pesquisa de produtos da HubSpot.

secondaryDisplayProperties
string[]
obrigatório

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.

createdAt
string<date-time>

Quando o tipo de objeto foi criado.

description
string

Uma descrição do 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.

updatedAt
string<date-time>

Quando o tipo de objeto foi atualizado pela última vez.

Last modified on April 13, 2026