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"
}Atualize atributos de um esquema de objeto personalizado, como propriedades e rótulos, usando o ID do tipo de objeto ou o nome totalmente qualificado.
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
Required Scopes
The access token received from the authorization server in the OAuth 2.0 flow.
Nome completo ou ID do tipo de objeto do seu esquema.
Indica se a descrição do tipo de objeto deve ser apagada.
Determina se o tipo de objeto pode incluir propriedades marcadas como confidenciais.
Uma breve explicação do tipo de objeto.
Show child attributes
O nome da propriedade principal para este objeto. Será exibido como principal na página de registro do HubSpot para este tipo de objeto.
Os nomes das propriedades que devem ser obrigatórias ao criar um objeto deste tipo.
Especifica se o tipo de objeto pode ser restaurado após ser excluído.
Nomes das propriedades que serão indexadas para este tipo de objeto na pesquisa de produtos da HubSpot.
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.
successful operation
Indica se o tipo de objeto permite propriedades que contêm dados confidenciais.
Indica se o tipo de objeto está arquivado.
Um ID exclusivo atribuído ao objeto, incluindo o ID do portal e o nome do objeto.
Um ID exclusivo para este tipo de objeto. Será definido como {meta-type}-{unique ID}.
Show child attributes
Um nome exclusivo para este objeto. Apenas para uso interno.
Um identificador exclusivo para o tipo de objeto.
Os nomes das propriedades que devem ser obrigatórias ao criar um objeto deste tipo.
Nomes das propriedades que serão indexadas para este tipo de objeto na pesquisa de produtos da HubSpot.
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.
Quando o tipo de objeto foi criado.
Uma descrição do tipo de objeto.
O ID da conta ao qual este objeto é específico.
O nome da propriedade principal para este objeto. Será exibido como principal na página de registro do HubSpot para este tipo de objeto.
Quando o tipo de objeto foi atualizado pela última vez.