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

Authorizations

hapikey
string
query
required

Path Parameters

appId
integer<int32>
required

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

objectType
string
required

O tipo de objeto cujo esquema você deseja atualizar.

Body

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

Response

successful operation

allowsSensitiveProperties
boolean
required
archived
boolean
required
fullyQualifiedName
string
required
id
string
required
labels
object
required
name
string
required
objectTypeId
string
required
requiredProperties
string[]
required
searchableProperties
string[]
required
secondaryDisplayProperties
string[]
required
createdAt
string<date-time>
description
string
portalId
integer<int32>
primaryDisplayProperty
string
updatedAt
string<date-time>
Last modified on September 3, 2025