> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
---
id: d24eb762-dac0-4f7d-a7a5-b4f98446b471
---
# Update the schema for an object type
> Update the schema for a specific object type within a given app. This operation allows you to modify the existing schema details, which can be useful for adapting to changes in data structure requirements or business logic.
export const SupportedProducts = ({marketing, sales, service, cms, data, commerce, crm, marketingLevel, salesLevel, serviceLevel, cmsLevel, dataLevel, commerceLevel, crmLevel}) => {
const translations = {
description: "Requires one of the following products or higher.",
productNames: {
marketing: "Marketing Hub",
sales: "Sales Hub",
service: "Service Hub",
cms: "Content Hub",
data: "Data Hub",
commerce: "Revenue Hub",
crm: "Smart CRM"
},
tiers: {
free: "Free",
starter: "Starter",
professional: "Professional",
enterprise: "Enterprise"
}
};
const translateTier = tier => {
if (!tier) return '';
const lowerTier = tier.toLowerCase();
return translations.tiers[lowerTier] || tier;
};
const products = [{
name: marketing ? translations.productNames.marketing : '',
level: translateTier(marketingLevel),
icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/MarketingHub.svg",
alt: "Marketing Hub"
}, {
name: sales ? translations.productNames.sales : '',
level: translateTier(salesLevel),
icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/SalesHub.svg",
alt: "Sales Hub"
}, {
name: service ? translations.productNames.service : '',
level: translateTier(serviceLevel),
icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/ServiceHub.svg",
alt: "Service Hub"
}, {
name: cms ? translations.productNames.cms : '',
level: translateTier(cmsLevel),
icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/ContentHub.svg",
alt: "Content Hub"
}, {
name: data ? translations.productNames.data : '',
level: translateTier(dataLevel),
icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/DataHub.svg",
alt: "Data Hub"
}, {
name: commerce ? translations.productNames.commerce : '',
level: translateTier(commerceLevel),
icon: "https://www.hubspot.com/hubfs/Knowledge_Base/subscription_key_icons/commerce_icon.svg",
alt: "Revenue Hub"
}, {
name: crm ? translations.productNames.crm : '',
level: translateTier(crmLevel),
icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/SmartCRM.svg",
alt: "Smart CRM"
}].filter(product => product.name && product.level);
if (products.length === 0) return null;
return
{translations.description}
{products.map((product, index) =>
{product.name} -{product.level}
)}
;
};
## OpenAPI
````yaml specs/2026-03/cms-media-bridge-v2026-03.json PATCH /media-bridge/2026-03/{appId}/schemas/{objectType}
openapi: 3.0.1
info:
title: CMS Media Bridge
description: Basepom for all HubSpot Projects
version: 2026-03
x-hubspot-product-tier-requirements:
marketing: FREE
sales: FREE
service: FREE
cms: FREE
commerce: FREE
crmHub: FREE
dataHub: FREE
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Advanced
- name: Basic
- name: Batch
paths:
/media-bridge/2026-03/{appId}/schemas/{objectType}:
patch:
tags:
- Basic
summary: Update schema
description: >-
Update the schema for a specific object type within a given app. This
operation allows you to modify the existing schema details, which can be
useful for adapting to changes in data structure requirements or
business logic.
operationId: patch-/media-bridge/2026-03/{appId}/schemas/{objectType}
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
explode: false
schema:
type: integer
format: int32
- name: objectType
in: path
description: ''
required: true
style: simple
explode: false
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectTypeDefinitionPatch'
required: true
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectTypeDefinition'
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- developers-write
components:
schemas:
ObjectTypeDefinitionPatch:
required:
- clearDescription
type: object
properties:
allowsSensitiveProperties:
type: boolean
description: >-
A boolean that specifies if the object type allows properties marked
as sensitive.
clearDescription:
type: boolean
description: >-
A boolean indicating whether the description should be cleared or
reset.
description:
type: string
description: A string providing a description of the object type.
labels:
$ref: '#/components/schemas/ObjectTypeDefinitionLabels'
primaryDisplayProperty:
type: string
description: >-
A string that identifies the primary property used for displaying
the object.
requiredProperties:
type: array
description: >-
An array of strings indicating which properties are required for the
object type.
items:
type: string
restorable:
type: boolean
description: >-
A boolean indicating whether the object type can be restored after
deletion.
searchableProperties:
type: array
description: >-
An array of strings specifying which properties can be used in
search queries.
items:
type: string
secondaryDisplayProperties:
type: array
description: >-
An array of strings that list additional properties used for
displaying the object.
items:
type: string
ObjectTypeDefinition:
required:
- allowsSensitiveProperties
- archived
- fullyQualifiedName
- id
- labels
- name
- objectTypeId
- requiredProperties
- searchableProperties
- secondaryDisplayProperties
type: object
properties:
allowsSensitiveProperties:
type: boolean
description: >-
A boolean indicating whether the object type allows sensitive
properties.
archived:
type: boolean
description: A boolean indicating whether the object type is archived.
createdAt:
type: string
description: >-
A string representing the date and time when the object type was
created, in ISO 8601 format.
format: date-time
description:
type: string
description: A string providing a description of the object type.
fullyQualifiedName:
type: string
description: A string representing the fully qualified name of the object type.
id:
type: string
description: A string representing the unique identifier for the object type.
labels:
$ref: '#/components/schemas/ObjectTypeDefinitionLabels'
name:
type: string
description: A string representing the name of the object type.
objectTypeId:
type: string
description: >-
A string representing the unique identifier for the object type
within the system.
portalId:
type: integer
description: >-
An integer representing the portal ID associated with the object
type.
format: int32
primaryDisplayProperty:
type: string
description: >-
A string representing the primary property used for displaying this
object type.
requiredProperties:
type: array
description: >-
An array of strings representing the properties that are required
for this object type.
items:
type: string
searchableProperties:
type: array
description: >-
An array of strings indicating which properties can be used in
search operations.
items:
type: string
secondaryDisplayProperties:
type: array
description: >-
An array of strings representing additional properties used for
displaying this object type.
items:
type: string
updatedAt:
type: string
description: >-
A string representing the date and time when the object type was
last updated, in ISO 8601 format.
format: date-time
ObjectTypeDefinitionLabels:
type: object
properties:
plural:
type: string
description: >-
The plural label for the object type, used to represent multiple
instances of the object. It is a string.
singular:
type: string
description: >-
The singular label for the object type, used to represent a single
instance of the object. It is a string.
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: The error category
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
A unique identifier for the request. Include this value with any
error reports or support tickets
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: further information about the error
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs containing documentation
about the error or recommended remediation steps
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
example: An error occurred
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
description: >-
Represents an error response returned by the API when an operation
fails. This component is used in various endpoints to provide detailed
information about the error encountered.
example:
message: Invalid input (details will vary based on the error)
correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
category: VALIDATION_ERROR
links:
knowledge-base: https://www.hubspot.com/products/service/knowledge-base
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: The status code associated with the error detail
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: The name of the field or parameter in which the error was found.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
description: >-
Represents detailed information about an error that occurred in the API.
This component is used to provide additional context and specifics about
errors, typically as part of an error response.
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.hubspot.com/oauth/authorize
tokenUrl: https://api.hubapi.com/oauth/v1/token
scopes:
developers-read: ''
developers-write: ''
media_bridge.write: ''
````
{product.name} -
{product.level}
)}