Create Channel Menus

POST

https://api.bigcommerce.com/stores/:store_hash/v3/channels/:channel_id/channel-menus

POST

/stores/:store_hash/v3/channels/:channel_id/channel-menus

curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/channels/1/channel-menus \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "bigcommerce_protected_app_sections": [
    "social",
    "carousel",
    "domains",
    "currencies",
    "notifications",
    "storefront_settings"
  ],
  "custom_app_sections": [
    {
      "title": "Overview",
      "query_path": "overview"
    },
    {
      "title": "Products",
      "query_path": "products"
    },
    {
      "title": "Campaigns",
      "query_path": "campaigns"
    },
    {
      "title": "Settings",
      "query_path": "settings"
    }
  ]
}'

{
  "data": {
    "bigcommerce_protected_app_sections": [
      "social",
      "carousel",
      "domains",
      "currencies",
      "notifications",
      "storefront_settings"
    ],
    "custom_app_sections": [
      {
        "title": "Overview",
        "query_path": "overview"
      },
      {
        "title": "Products",
        "query_path": "products"
      },
      {
        "title": "Campaigns",
        "query_path": "campaigns"
      },
      {
        "title": "Settings",
        "query_path": "settings"
      }
    ]
  },
  "meta": {}
}

Creates or replaces the list of control panel side navigation menus for a channel.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Channel Listings	modify	`store_channel_listings`
Channel Listings	read-only	`store_channel_listings_read_only`
Channel Settings	modify	`store_channel_settings`
Channel Settings	read-only	`store_channel_settings_read_only`
Sites & Routes	modify	`store_sites`
Sites & Routes	read-only	`store_sites_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

channel_idlongRequired

The ID of a channel.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects an object.

bigcommerce_protected_app_sectionslist of enumsOptional

List of channel-specific control panel menu navigation items and corresponding settings pages an app developer can choose to enable for the subject channel. Protected settings override any settings set in those UI sections at the storewide level. Learn more in the Building Storefront Channels tutorial.

custom_app_sectionslist of objectsOptional

Response

The channel’s control-panel menus.

dataobjectOptional

metaobjectOptional

Response metadata.

Errors

422

Unprocessable Entity Error