HubSpot CMS Media Bridge API

openapi: 3.0.1
info:
  title: HubSpot CMS Media Bridge
  description: Basepom for all HubSpot Projects
  version: 2026-09
  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
tags:
- name: Advanced
- name: Basic
- name: Batch
paths:
  /media-bridge/2026-09/events/attention-span:
    post:
      tags:
      - Advanced
      summary: Create Event
      description: Create a new attention span event in the MediaBridgeService. This endpoint is used
        to record attention span events, which can be useful for tracking user engagement with media content.
        The request must include a valid JSON body conforming to the AttentionSpanEventRequest schema.
      operationId: post-/media-bridge/2026-09/events/attention-span
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AttentionSpanEventRequest'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttentionSpanEvent'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - media_bridge.write
  /media-bridge/2026-09/events/media-played:
    post:
      tags:
      - Advanced
      summary: Create
      description: Create a media played event in the HubSpot account. This endpoint is used to log when
        media content has been played, which can be useful for tracking user engagement with media resources.
      operationId: post-/media-bridge/2026-09/events/media-played
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MediaPlayedEventRequest'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPlayedEvent'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - media_bridge.write
  /media-bridge/2026-09/events/media-played-percent:
    post:
      tags:
      - Advanced
      summary: Record Media Played Percentage
      description: This endpoint allows you to record the percentage of media that has been played. It
        is useful for tracking user engagement with media content, such as videos or audio files, by capturing
        the extent to which the media has been consumed. This data can be used for analytics and improving
        content delivery strategies.
      operationId: post-/media-bridge/2026-09/events/media-played-percent
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MediaPlayedPercentageEventRequest'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPlayedPercentageEvent'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - media_bridge.write
  /media-bridge/2026-09/{appId}/properties/{objectType}:
    get:
      tags:
      - Basic
      summary: Retrieve properties
      description: Retrieve properties for a specified object type within a given app. This endpoint allows
        you to filter properties based on whether they are archived and to specify which properties to
        include in the response. It is useful for accessing and managing the properties associated with
        different object types in your application.
      operationId: get-/media-bridge/2026-09/{appId}/properties/{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
      - name: archived
        in: query
        description: Whether to return only results that have been archived.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: properties
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponsePropertyNoPaging'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - developers-read
    post:
      tags:
      - Basic
      summary: Create property
      description: Create a new property for a specified object type within a given app in the MediaBridge
        service. This endpoint allows you to define new properties that can be used to store additional
        information related to the object type. The request must include the necessary property details
        in the request body.
      operationId: post-/media-bridge/2026-09/{appId}/properties/{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/PropertyCreate'
        required: true
      responses:
        '201':
          description: successful operation
          headers:
            Location:
              description: URL of the newly created resource
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Property'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - developers-write
  /media-bridge/2026-09/{appId}/properties/{objectType}/batch/archive:
    post:
      tags:
      - Batch
      summary: Batch archive properties
      description: Archive multiple properties for a specified object type within a given app. This endpoint
        is useful for managing large sets of properties that are no longer needed or should be hidden
        from active use. It requires specifying the app ID and object type in the path parameters.
      operationId: post-/media-bridge/2026-09/{appId}/properties/{objectType}/batch/archive
      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/BatchInputPropertyName'
        required: true
      responses:
        '204':
          description: No content
          content: {}
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - developers-write
  /media-bridge/2026-09/{appId}/properties/{objectType}/batch/create:
    post:
      tags:
      - Batch
      summary: Batch create properties
      description: Create multiple properties in a batch for a specified object type within a given app.
        This endpoint is useful for efficiently setting up multiple properties at once, reducing the need
        for multiple individual API calls.
      operationId: post-/media-bridge/2026-09/{appId}/properties/{objectType}/batch/create
      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/BatchInputPropertyCreate'
        required: true
      responses:
        '201':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchResponseProperty'
        '207':
          description: multiple statuses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchResponsePropertyWithErrors'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - developers-write
  /media-bridge/2026-09/{appId}/properties/{objectType}/batch/read:
    post:
      tags:
      - Batch
      summary: Batch read properties
      description: Retrieve a batch of properties for a specified object type within a given app. This
        endpoint is useful for fetching multiple properties efficiently in a single request, especially
        when dealing with large datasets or when specific properties are needed for processing.
      operationId: post-/media-bridge/2026-09/{appId}/properties/{objectType}/batch/read
      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/BatchReadInputPropertyName'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchResponseProperty'
        '207':
          description: multiple statuses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchResponsePropertyWithErrors'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - developers-read
  /media-bridge/2026-09/{appId}/properties/{objectType}/groups:
    get:
      tags:
      - Basic
      summary: List groups
      description: Retrieve a list of property groups for a specified object type within a given app.
        This endpoint is useful for obtaining organizational information about properties associated with
        different object types in your application.
      operationId: get-/media-bridge/2026-09/{appId}/properties/{objectType}/groups
      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
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponsePropertyGroupNoPaging'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - developers-read
    post:
      tags:
      - Basic
      summary: Create Group
      description: Create a new property group for a specified object type within a given app. This endpoint
        allows you to organize properties into groups, making it easier to manage and categorize them
        within your application.
      operationId: post-/media-bridge/2026-09/{appId}/properties/{objectType}/groups
      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/PropertyGroupCreate'
        required: true
      responses:
        '201':
          description: successful operation
          headers:
            Location:
              description: URL of the newly created resource
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyGroup'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - developers-write
  /media-bridge/2026-09/{appId}/properties/{objectType}/groups/{groupName}:
    get:
      tags:
      - Basic
      summary: Retrieve group
      description: Retrieve a specific property group for a given object type within an app. This endpoint
        is useful for accessing detailed information about how properties are grouped under a specific
        group name for a particular object type in your application.
      operationId: get-/media-bridge/2026-09/{appId}/properties/{objectType}/groups/{groupName}
      parameters:
      - name: appId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int32
      - name: groupName
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: objectType
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyGroup'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - developers-read
    delete:
      tags:
      - Basic
      summary: Delete group
      description: Delete a specific property group for a given object type within an app. This operation
        is useful for removing unnecessary or obsolete property groups, helping to maintain a clean and
        organized structure within your app's properties.
      operationId: delete-/media-bridge/2026-09/{appId}/properties/{objectType}/groups/{groupName}
      parameters:
      - name: appId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int32
      - name: groupName
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: objectType
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: No content
          content: {}
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - developers-write
    patch:
      tags:
      - Basic
      summary: Update group
      description: Update the properties of a specific group within a specified object type for a given
        app. This operation allows you to modify the details of a property group, such as its label or
        display order, within the context of the MediaBridge service.
      operationId: patch-/media-bridge/2026-09/{appId}/properties/{objectType}/groups/{groupName}
      parameters:
      - name: appId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int32
      - name: groupName
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: objectType
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropertyGroupUpdate'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyGroup'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - developers-write
  /media-bridge/2026-09/{appId}/properties/{objectType}/{propertyName}:
    get:
      tags:
      - Basic
      summary: Retrieve property
      description: Retrieve a specific property for a given object type within a specified app. This endpoint
        allows you to access details about a property, including its configuration and settings, for a
        particular object type identified by the property name. This can be useful for understanding property
        configurations or for integration purposes.
      operationId: get-/media-bridge/2026-09/{appId}/properties/{objectType}/{propertyName}
      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
      - name: propertyName
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: archived
        in: query
        description: Whether to return only results that have been archived.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: properties
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Property'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - developers-read
    delete:
      tags:
      - Basic
      summary: Delete property
      description: Delete a specific property from a given object type within an app. This operation is
        useful for removing properties that are no longer needed or were created in error. The endpoint
        requires specifying the app ID, object type, and property name to identify the property to be
        deleted.
      operationId: delete-/media-bridge/2026-09/{appId}/properties/{objectType}/{propertyName}
      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
      - name: propertyName
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: No content
          content: {}
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - developers-write
    patch:
      tags:
      - Basic
      summary: Update property
      description: Update an existing property for a specified object type within a given app. This operation
        allows you to modify the details of a property, such as its label, type, or description, to better
        fit your application's requirements.
      operationId: patch-/media-bridge/2026-09/{appId}/properties/{objectType}/{propertyName}
      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
      - name: propertyName
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MediaBridgePropertyUpdate'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Property'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - developers-write
  /media-bridge/2026-09/{appId}/schemas:
    get:
      tags:
      - Basic
      summary: Retrieve schemas
      description: Retrieve the schemas associated with a specific app in the HubSpot account. This endpoint
        allows you to fetch schema details, which can be useful for understanding the data structure and
        properties associated with the app. You can optionally filter the results to include only archived
        schemas.
      operationId: get-/media-bridge/2026-09/{appId}/schemas
      parameters:
      - name: appId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int32
      - name: archived
        in: query
        description: Whether to return only results that have been archived.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseObjectSchemaNoPaging'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - developers-read
  /media-bridge/2026-09/{appId}/schemas/{objectType}:
    get:
      tags:
      - Basic
      summary: Retrieve schema
      description: Retrieve the schema for a specific object type within a given app in your HubSpot account.
        This endpoint is useful for understanding the structure and properties of a particular object
        type, which can assist in data integration and management tasks.
      operationId: get-/media-bridge/2026-09/{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
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectSchema'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - developers-read
    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-09/{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:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - developers-write
  /media-bridge/2026-09/{appId}/schemas/{objectType}/associations:
    post:
      tags:
      - Advanced
      summary: Create associations
      description: Create new associations for a specified object type within a given app. This endpoint
        allows you to define relationships between different object types, enhancing data connectivity
        and integration within your HubSpot account.
      operationId: post-/media-bridge/2026-09/{appId}/schemas/{objectType}/associations
      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/AssociationDefinitionEgg'
        required: true
      responses:
        '201':
          description: successful operation
          headers:
            Location:
              description: URL of the newly created resource
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssociationDefinition'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - developers-write
  /media-bridge/2026-09/{appId}/schemas/{objectType}/associations/{associationId}:
    delete:
      tags:
      - Basic
      summary: Delete association
      description: Remove an existing association between schemas for a specified app in the MediaBridge
        service. This operation is useful when you need to disassociate entities that are no longer related
        or to clean up outdated associations.
      operationId: delete-/media-bridge/2026-09/{appId}/schemas/{objectType}/associations/{associationId}
      parameters:
      - name: appId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int32
      - name: associationId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: objectType
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: No content
          content: {}
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - developers-write
  /media-bridge/2026-09/{appId}/settings:
    put:
      tags:
      - Basic
      summary: Update settings
      description: Update the settings for a specific app in the MediaBridgeService. This endpoint allows
        you to modify the configuration settings associated with the specified appId. It is useful for
        updating app-specific settings to ensure they align with your current requirements.
      operationId: put-/media-bridge/2026-09/{appId}/settings
      parameters:
      - name: appId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MediaBridgeProviderPartial'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaBridgeProviderRegistrationResponse'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - developers-write
  /media-bridge/2026-09/{appId}/settings/event-visibility:
    get:
      tags:
      - Basic
      summary: Retrieve settings
      description: Retrieve the event visibility settings for a specific app in the MediaBridge service.
        This endpoint provides information on how events are visible within the specified application
        context.
      operationId: get-/media-bridge/2026-09/{appId}/settings/event-visibility
      parameters:
      - name: appId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventVisibilityResponse'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - developers-read
    patch:
      tags:
      - Basic
      summary: Update settings
      description: Update the event visibility settings for a specific app in the MediaBridgeService.
        This operation allows you to modify how events are displayed or managed for the specified app.
        It is useful for configuring event visibility preferences based on your application's requirements.
      operationId: patch-/media-bridge/2026-09/{appId}/settings/event-visibility
      parameters:
      - name: appId
        in: path
        description: ''
        required

# --- truncated at 32 KB (733 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/openapi/hubspot-cms-media-bridge-api-openapi.yml