Kodkila Developers

GET/cms/channels/{channelId}/menusList the channel's menus
POST/cms/channels/{channelId}/menusCreate a menu
GET/cms/channels/{channelId}/menus/{menuId}Get a menu with its item tree
PATCH/cms/channels/{channelId}/menus/{menuId}Update a menu (name, location, status)
DELETE/cms/channels/{channelId}/menus/{menuId}Delete a menu and all its items
POST/cms/channels/{channelId}/menus/{menuId}/itemsAdd a menu item
PATCH/cms/channels/{channelId}/menus/{menuId}/items/{itemId}Update / move a menu item
DELETE/cms/channels/{channelId}/menus/{menuId}/items/{itemId}Delete a menu item and its sub-items
PUT/cms/channels/{channelId}/menus/{menuId}/items/orderRe-parent/re-sort every item of the menu

List the channel's menus

GET/cms/channels/{channelId}/menus

Needs a signed-in user (Bearer token or access_token cookie).

Parameters

Name	Type	Description
channelIdrequired	string, path

Response

200. data is object[].

Create a menu

POST/cms/channels/{channelId}/menus

Needs a signed-in user (Bearer token or access_token cookie).

Parameters

Name	Type	Description
channelIdrequired	string, path

Request body application/json

Field	Type	Description
namerequired	string	At most 120 characters. Example: "Main menu"
location	string	Where it renders At most 60 characters. Example: "header"
status	string	One of: "draft", "published".
sort	number	Minimum 0, maximum 10000.

Response

201. The payload in data is of type object.

Get a menu with its item tree

GET/cms/channels/{channelId}/menus/{menuId}

Needs a signed-in user (Bearer token or access_token cookie).

Parameters

Name	Type	Description
channelIdrequired	string, path
menuIdrequired	number, path

Response

200. The payload in data is of type object.

Update a menu (name, location, status)

PATCH/cms/channels/{channelId}/menus/{menuId}

Needs a signed-in user (Bearer token or access_token cookie).

Parameters

Name	Type	Description
channelIdrequired	string, path
menuIdrequired	number, path

Request body application/json

Field	Type	Description
name	string	At most 120 characters.
location	string	At most 60 characters. Example: "footer"
status	string	One of: "draft", "published", "archived".
sort	number	Minimum 0, maximum 10000.

Response

200. The payload in data is of type object.

Delete a menu and all its items

DELETE/cms/channels/{channelId}/menus/{menuId}

Needs a signed-in user (Bearer token or access_token cookie).

Parameters

Name	Type	Description
channelIdrequired	string, path
menuIdrequired	number, path

Response

200. The payload in data is not described in the spec yet.

Add a menu item

POST/cms/channels/{channelId}/menus/{menuId}/items

Needs a signed-in user (Bearer token or access_token cookie).

Parameters

Name	Type	Description
channelIdrequired	string, path
menuIdrequired	number, path

Request body application/json

Field	Type	Description
labelrequired	string	At most 120 characters. Example: "Shop"
urlrequired	string	Example: "/shop"
target	string	One of: "_self", "_blank".
parent_id	number	Parent item id (same menu) or null Minimum 1.
sort	number	Minimum 0, maximum 10000.
status	string	One of: "draft", "published", "archived".

Response

201. The payload in data is not described in the spec yet.

Update / move a menu item

PATCH/cms/channels/{channelId}/menus/{menuId}/items/{itemId}

Needs a signed-in user (Bearer token or access_token cookie).

Parameters

Name	Type	Description
channelIdrequired	string, path
menuIdrequired	number, path
itemIdrequired	number, path

Request body application/json

Field	Type	Description
label	string	At most 120 characters.
url	string	Example: "/about-us"
target	string	One of: "_self", "_blank".
parent_id	number	New parent id, or null for top level Minimum 1.
sort	number	Minimum 0, maximum 10000.
status	string	One of: "draft", "published", "archived".

Response

200. The payload in data is of type object.

Delete a menu item and its sub-items

DELETE/cms/channels/{channelId}/menus/{menuId}/items/{itemId}

Needs a signed-in user (Bearer token or access_token cookie).

Parameters

Name	Type	Description
channelIdrequired	string, path
menuIdrequired	number, path
itemIdrequired	number, path

Response

200. The payload in data is not described in the spec yet.

Re-parent/re-sort every item of the menu

PUT/cms/channels/{channelId}/menus/{menuId}/items/order

Needs a signed-in user (Bearer token or access_token cookie).

Parameters

Name	Type	Description
channelIdrequired	string, path
menuIdrequired	number, path

Request body application/json

Field	Type	Description
itemsrequired	object[]	Every item of the menu with its new parent and sort
items[].idrequired	number	Minimum 1.
items[].parent_id	number	Minimum 1.
items[].sortrequired	number	Minimum 0, maximum 10000.

Response

200. The payload in data is of type object.

CMS · menus

List the channel's menus

Parameters

Response

Create a menu

Parameters

Request body application/json

Response

Get a menu with its item tree

Parameters

Response

Update a menu (name, location, status)

Parameters

Request body application/json

Response

Delete a menu and all its items

Parameters

Response

Add a menu item

Parameters

Request body application/json

Response

Update / move a menu item

Parameters

Request body application/json

Response

Delete a menu item and its sub-items

Parameters

Response

Re-parent/re-sort every item of the menu

Parameters

Request body application/json

Response