> ## Documentation Index
> Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update the schema for an object type

> Atualize o esquema para um tipo de objeto específico em um determinado aplicativo. Essa operação permite modificar os dadis do esquema, o que pode ser útil para se adaptar a mudanças nos requisitos da estrutura de dados ou na lógica de negócios.

> **Supported products**


## 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: Atualizar esquema
      description: >-
        Atualize o esquema para um tipo de objeto específico em um determinado
        aplicativo. Essa operação permite modificar os dadis do esquema, o que
        pode ser útil para se adaptar a mudanças nos requisitos da estrutura de
        dados ou na lógica de negócios.
      operationId: patch-/media-bridge/2026-03/{appId}/schemas/{objectType}
      parameters:
        - name: appId
          in: path
          description: O identificador único do aplicativo associado ao esquema.
          required: true
          style: simple
          explode: false
          schema:
            type: integer
            format: int32
        - name: objectType
          in: path
          description: O tipo de objeto cujo esquema está sendo atualizado.
          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:
        - developer_hapikey: []
components:
  schemas:
    ObjectTypeDefinitionPatch:
      required:
        - clearDescription
      type: object
      properties:
        allowsSensitiveProperties:
          type: boolean
          description: >-
            Um valor booleano que especifica se o tipo de objeto permite
            propriedades marcadas como confidenciais.
        clearDescription:
          type: boolean
          description: >-
            Um valor booleano que indica se a descrição deve ser limpa ou
            redefinida.
        description:
          type: string
          description: Uma string que fornece uma descrição do tipo de objeto.
        labels:
          $ref: '#/components/schemas/ObjectTypeDefinitionLabels'
        primaryDisplayProperty:
          type: string
          description: >-
            Uma string que identifica a propriedade principal usada para exibir
            o objeto.
        requiredProperties:
          type: array
          description: >-
            Uma matriz de strings que indicam quais propriedades são necessárias
            para o tipo de objeto.
          items:
            type: string
        restorable:
          type: boolean
          description: >-
            Um valor booleano que indica se o tipo de objeto pode ser restaurado
            após a exclusão.
        searchableProperties:
          type: array
          description: >-
            Uma matriz de strings que especifica quais propriedades podem ser
            usadas em consultas de pesquisa.
          items:
            type: string
        secondaryDisplayProperties:
          type: array
          description: >-
            Uma matriz de strings que lista propriedades adicionais usadas para
            exibir o objeto.
          items:
            type: string
    ObjectTypeDefinition:
      required:
        - allowsSensitiveProperties
        - archived
        - fullyQualifiedName
        - id
        - labels
        - name
        - objectTypeId
        - requiredProperties
        - searchableProperties
        - secondaryDisplayProperties
      type: object
      properties:
        allowsSensitiveProperties:
          type: boolean
          description: >-
            Um booleano que indica se o tipo de objeto permite propriedades
            confidenciais.
        archived:
          type: boolean
          description: Um valor booleano que indica se o tipo de objeto está arquivado.
        createdAt:
          type: string
          description: >-
            Uma string que representa a data e a hora em que o tipo de objeto
            foi criado, no formato ISO 8601.
          format: date-time
        description:
          type: string
          description: Uma string que fornece uma descrição do tipo de objeto.
        fullyQualifiedName:
          type: string
          description: >-
            Uma string que representa o nome totalmente qualificado do tipo de
            objeto.
        id:
          type: string
          description: >-
            Uma string que representa o identificador exclusivo para o tipo de
            objeto.
        labels:
          $ref: '#/components/schemas/ObjectTypeDefinitionLabels'
        name:
          type: string
          description: Uma string que representa o nome do tipo de objeto.
        objectTypeId:
          type: string
          description: >-
            Uma string que representa o identificador exclusivo para o tipo de
            objeto dentro do sistema.
        portalId:
          type: integer
          description: >-
            Um número inteiro que representa o ID do portal associado ao tipo de
            objeto.
          format: int32
        primaryDisplayProperty:
          type: string
          description: >-
            Uma string que representa a propriedade principal usada para exibir
            este tipo de objeto.
        requiredProperties:
          type: array
          description: >-
            Uma matriz de strings que representam as propriedades necessárias
            para este tipo de objeto.
          items:
            type: string
        searchableProperties:
          type: array
          description: >-
            Uma matriz de strings que indica quais propriedades podem ser usadas
            em operações de pesquisa.
          items:
            type: string
        secondaryDisplayProperties:
          type: array
          description: >-
            Uma matriz de strings que representam propriedades adicionais usadas
            para exibir este tipo de objeto.
          items:
            type: string
        updatedAt:
          type: string
          description: >-
            Uma string que representa a data e a hora em que o tipo de objeto
            foi atualizado pela última vez, no formato ISO 8601.
          format: date-time
    ObjectTypeDefinitionLabels:
      type: object
      properties:
        plural:
          type: string
          description: >-
            O rótulo no plural para o tipo de objeto, usado para representar
            várias instâncias do objeto. É uma string.
        singular:
          type: string
          description: >-
            O rótulo no singular para o tipo de objeto, usado para representar
            uma única instância do objeto. É uma string.
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: A categoria de erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Um identificador exclusivo para a solicitação. Inclua este valor em
            relatórios de erro ou tickets de suporte
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: mais informações sobre o erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um mapa de nomes de links para URIs associados que contêm
            documentação sobre o erro ou as etapas de correção recomendadas
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa uma resposta de erro retornada pela API quando uma operação
        falha. Este componente é usado em vários endpoints para fornecer
        informações detalhadas sobre o erro encontrado.
      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: O código de status associado ao detalhe do erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: O nome do campo ou parâmetro no qual o erro foi encontrado.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa informações detalhadas sobre um erro ocorrido na API. Este
        componente é usado para fornecer contexto e detalhes adicionais sobre os
        erros, geralmente como parte de uma resposta de erro.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    developer_hapikey:
      type: apiKey
      name: hapikey
      in: query

````