Skip to main content
PATCH
/
media-bridge
/
v1
/
{appId}
/
schemas
/
{objectType}
Update the schema for an object type
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"
}

Supported products

Requires one of the following products or higher.
Marketing HubMarketing Hub -Free
Sales HubSales Hub -Free
Service HubService Hub -Free
Content HubContent Hub -Free
Data HubData Hub -Free

Authorizations

hapikey
string
query
required

Path Parameters

appId
integer<int32>
required

The appId for the media bridge app. It is possible to have multiple apps in your developer account that use the media bridge.

objectType
string
required

The object type that you want to update the schema for.

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 December 16, 2025