Pular para o conteúdo principal
PATCH
/
media-bridge
/
v1
/
{appId}
/
schemas
/
{objectType}
Atualizar o esquema para um tipo de objeto
curl --request PATCH \
  --url 'https://api.hubapi.com/media-bridge/v1/{appId}/schemas/{objectType}?hapikey=' \
  --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"
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubGrátis

Autorizações

hapikey
string
query
obrigatório

Parâmetros de caminho

appId
integer<int32>
obrigatório

O appId do aplicativo Media Bridge. É possível ter vários aplicativos na sua conta de desenvolvedor que usam a Media Bridge.

objectType
string
obrigatório

O tipo de objeto cujo esquema você deseja atualizar.

Corpo

application/json
clearDescription
boolean
obrigatório
allowsSensitiveProperties
boolean
description
string
labels
object
primaryDisplayProperty
string
requiredProperties
string[]
restorable
boolean
searchableProperties
string[]
secondaryDisplayProperties
string[]

Resposta

successful operation

allowsSensitiveProperties
boolean
obrigatório
archived
boolean
obrigatório
fullyQualifiedName
string
obrigatório
id
string
obrigatório
labels
object
obrigatório
name
string
obrigatório
objectTypeId
string
obrigatório
requiredProperties
string[]
obrigatório
searchableProperties
string[]
obrigatório
secondaryDisplayProperties
string[]
obrigatório
createdAt
string<date-time>
description
string
portalId
integer<int32>
primaryDisplayProperty
string
updatedAt
string<date-time>
Last modified on January 23, 2026