Jump to Content
ContentHomeEngagementContentDiscoveryOther Resources
GuidesAPI ReferenceGraphQLRelease NotesHelp Center
HomeEngagementContentDiscoveryOther ResourcesContent
API Reference
GuidesAPI ReferenceGraphQLRelease NotesHelp Center

Overview

  • Welcome
  • Get started

Delivery API 1.0

  • Delivery API 1.0
  • Channels endpoint
  • Pages endpoint
  • Documents endpoint
  • Images endpoint
  • Pages JSON representation
    • Pages
    • Components
    • Content Items
    • Links
    • Menus
  • Document JSON representation
  • Resource URLs
  • Reserved names
  • Delivery API JWT authentication

Delivery API 2.0

  • Delivery API 2.0
  • Authorization

Documents Delivery API 2.0

  • Documents Delivery API 2.0
    • Schemas
  • Documents API
    • Get document by id or pathget
    • Get documents by queryget

Folders Delivery API 2.0

  • Folders Delivery API 2.0
    • Schemas
  • Folders API
    • Get folder by id or pathget

Images Delivery API 2.0

  • Images Delivery API 2.0
    • Schemas
  • Images API
    • Get image by id or pathget
    • Get Images by queryget

Assets Delivery API 2.0

  • Assets Delivery API 2.0
    • Schemas
  • Assets API
    • Get an asset by id or pathget
    • Get assets by queryget

Delivery Auth API 2.0

  • Delivery Auth API 2.0
  • Auth Operations
    • Obtain a JWT tokenpost

Management APIs

  • Management APIs
  • Authentication
  • Updates and conflict prevention
  • Postman collections
  • OpenAPI specs

Site Management API

  • Site Management API
    • Schemas
  • Channel Operations
    • Get meta-data for a channel parameterget
    • Add or update meta-data for a channel parameterput
    • Delete channel parameter meta-datadelete
    • Get meta-data for a field groupget
    • Add or update meta-data for a field groupput
    • Delete a field groupdelete
    • Get a channelget
    • Update an existing channelput
    • Delete an existing channeldelete
    • Get meta-data for all channel parametersget
    • Get all channelsget
    • Create a channel developer branchpost
    • Get meta-data for all field groupsget
  • Channel Component Operations
    • Get a channel component groupget
    • Create or update a channel component groupput
    • Delete an empty channel component groupdelete
    • Get a component within a component groupget
    • Create or update a component within a component groupput
    • Delete an unreferenced component from a component groupdelete
    • Get all components for a component groupget
    • Get all component groups for a channelget
  • Channel Layout Operations
    • Get a channel layoutget
    • Create or update a channel layoutput
    • Delete a channel layoutdelete
    • Get the channel layoutsget
  • Channel Route Operations
    • Get a routeget
    • Create or update a routeput
    • Delete a routedelete
    • Get the channel routesget
  • Channel Menu Operations
    • Get a channel menu (name)get
    • Create a channel menu (name)put
    • Delete a channel menudelete
    • Get channel menu itemsget
    • Update channel menu itemsput
    • Get channel menu template propertiesget
    • Create or update channel menu template propertiesput
    • Get all channel menu (names)get

Content Type Management API

  • Content Type Management API
    • Schemas
    • Content types
    • Content type fields
  • Content Type Operations
    • Get a content typeget
    • Create or update a content typeput
    • Delete a content typedelete
    • Get all content typesget
    • Rename a content typepost

Content Management API

  • Content Management API
    • Schemas
  • Content Document Operations
    • Get a document in a specific projectget
    • Create or update a document in a specific projectput
    • Dissociate a document from a projectdelete
  • Content Page Operations
    • Get a page in a specific projectget
    • Create or update a page in a specific project and channelput
    • Dissociate an experience page from a projectdelete
  • Content Resource Bundle Operations
    • Get a resource bundle in a specific projectget
    • Create or update a resource bundle in a specific projectput
    • Dissociate a resource bundle document from a projectdelete
  • Content Translation Operations
    • Get translations of the contentget
    • Link the source and target content as translations of each otherpost
    • Unlink the content from any existing translationspost
    • Get the status of a link/unlink operationget

Folder Management API

  • Folder Management API
    • Schemas
  • Folder Operations
    • Get a folderget
    • Create or update a folderput
    • Delete a folderdelete
    • Move/Rename a folderpost

Content Batch Import API

  • Content Batch Import API
  • Content Import Batch Operations
    • Get operation detailsget
    • Create content (documents and pages) in a specific project.post
    • List all operationsget

Content Batch Export API

  • Content Batch Export API
  • Content Export Batch Operations
    • Download the filesget
    • Get operation detailsget
    • List all operationsget
    • Request an exportpost

Project Management API

  • Project Management API
    • Schemas
  • Project Operations
    • Get a developer projectget
    • Update a developer projectput
    • Delete a developer projectdelete
    • Get all developer projectsget
    • Create a developer projectpost
    • Rebase a developer projectpost
    • Merge a developer projectpost
    • Reopen a developer projectpost

Content Integrations Management API

  • Content Integrations Management API
  • UI Extensions Config Operations
    • Get a single custom UI extensionget
    • Create or update a custom UI extensionput
    • Delete a custom UI extensiondelete
    • Get content types that use an existing UI extensionget
    • Get all custom UI extensionsget

Delivery API Settings Management API

  • Delivery API Settings Management API
    • Schemas
  • Delivery API V1 Operations
    • Get Delivery API V1 Settingsget
    • Update Delivery API V1 Settingspatch
  • Delivery API V2 Operations
    • Get Delivery API V2 Settingsget
    • Update Delivery API V2 Settingspatch

Webhook Management API

  • Webhook Management API
  • Webhook Configuration Operations
    • Get a webhook configurationget
    • Update a webhook configurationput
    • Delete a webhook configurationdelete
    • Get all webhook configurationsget
    • Create a webhook configurationpost
  • Webhook Execution Operations
    • Get a webhook executionget
    • Get all webhook executionsget

GraphQL Commerce API

  • GraphQL Commerce API
    • Access management
    • GraphQL Commerce schema
    • Examples
    • FAQ
    • Release notes
  • GraphQL Commerce API guides
    • Bloomreach Discovery
    • BigCommerce
    • commercetools
    • SAP Commerce Cloud
    • Shopify
  • GraphQL Commerce API tutorials
    • Bloomreach Discovery schema mapping
    • Commerce pickers in Content SaaS
    • Connect with Reference SPA
    • Extend using Apollo Federation

Channel Menu Operations

The upcoming pages contain Site Management APIs that will help you:

  • Get a channel menu (name),
  • Create a channel menu (name),
  • Delete a channel menu,
  • Get all channel menu (names),
  • Get channel menu template properties,
  • Create or update channel menu template properties,
  • Get channel menu items, and
  • Update channel menu items.
Read Bloomreach Experience reviews on G2
Read Bloomreach Experience reviews on Trustradius
Legal
  • Terms of Service
    |
  • Privacy Policy
    |
  • Contact DPO
    |
  • Control Your Data
    |
  • Cookie Settings
    |
  • Quality, Infosec, BCM policy
    |
  • UK Modern Slavery Act
© 2021 Bloomreach, Inc. All rights reserved.