Channel Menu Operations - Bloomreach Experience - The Headless Digital Experience Platform Built for Commerce

Channel Menu Operations

GET​/channels​/{channel_id}​/menus

Get all channel menu (names).

Parameters

Name Description

channel_id *

string

(path)

Channel id. Optionally includes the project id, separated by a dash: mychannel-branchId

Example : brxsaas-vIUy9

Responses

Code Description
200

OK

Media type: application/json

Schema: [string]

Example:

[
  "main"
]
403

Forbidden

404

Not Found

GET​ /channels​/{channel_id}​/menus​/{menu_name}

Get a channel menu (name).

Parameters

Name Description

channel_id *

string

(path)

Channel id. Optionally includes the project id, separated by a dash: mychannel-branchId

Example : brxsaas-vIUy9

menu_name *

string

(path)

Name of menu

Example : main

Responses

Code Description
200

OK

Media type: application/json

Schema: string

Example:

"main"

Headers:

Name Description Type
X-Resource-Version

Resource's version. Must be used in any subsequent update requests of this resource

string
403

Forbidden

404

Not Found

PUT​/channels​/{channel_id}​/menus​/{menu_name}

Create a channel menu (name).

Parameters

Name Description

X-Resource-Version

string

(header)

Resource's version. Must be used in any subsequent update requests of this resource. Can be obtained when GETting the resource

Example : 433cc90445d29c2356e385b9efe548b19ed86739f27eb7958a81847b9d8517c2

channel_id *

string

(path)

Channel id. Optionally includes the project id, separated by a dash: mychannel-branchId

Example : brxsaas-vIUy9

menu_name *

string

(path)

Name of menu

Example : main

Responses

Code Description
201

OK

Media type: application/json

Schema: string

Example:

"main"

Headers:

Name Description Type
X-Resource-Version

Resource's version. Must be used in any subsequent update requests of this resource

string
403

Forbidden

DELETE​ /channels​/{channel_id}​/menus​/{menu_name}

Delete a channel menu.

Parameters

Name Description

channel_id *

string

(path)

Channel id. Optionally includes the project id, separated by a dash: mychannel-branchId

Example : brxsaas-vIUy9

menu_name *

string

(path)

Name of menu

Example : main

Responses

Code Description
200

OK

204

No Content

403

Forbidden

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?