> For the complete documentation index, see [llms.txt](https://docs.xibosignage.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xibosignage.com/developer/integrate/openapi/menu-board.md).

# Menu Board

Menu Boards - feature preview, please do not use in production.

## Search Menu Boards

> Search all Menu Boards this user has access to

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"paths":{"/menuboards":{"get":{"tags":["menuBoard"],"summary":"Search Menu Boards","description":"Search all Menu Boards this user has access to","operationId":"menuBoardSearch","parameters":[{"name":"menuId","in":"query","description":"Filter by Menu board Id","required":false,"schema":{"type":"integer"}},{"name":"userId","in":"query","description":"Filter by Owner Id","required":false,"schema":{"type":"integer"}},{"name":"folderId","in":"query","description":"Filter by Folder Id","required":false,"schema":{"type":"integer"}},{"name":"name","in":"query","description":"Filter by name","required":false,"schema":{"type":"string"}},{"name":"code","in":"query","description":"Filter by code","required":false,"schema":{"type":"string"}},{"name":"modifiedDateFrom","in":"query","description":"Filter by modified date (from)","required":false,"schema":{"type":"string"}},{"name":"modifiedDateTo","in":"query","description":"Filter by modified date (to)","required":false,"schema":{"type":"string"}},{"name":"sortBy","in":"query","description":"Specifies which field the results are sorted by. Used together with sortDir","required":false,"schema":{"type":"string","enum":["menuId","name","code","modifiedDt","owner","folderName","groupsWithPermissions"]}},{"name":"sortDir","in":"query","description":"Sort direction","required":false,"schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"successful operation","headers":{"X-Total-Count":{"description":"The total number of records","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MenuBoard"}}}}}}}}},"components":{"schemas":{"MenuBoard":{"description":"Class MenuBoard","properties":{"menuId":{"description":"The Menu Board Id"},"name":{"description":"The Menu Board name"},"description":{"description":"The Menu Board description"},"code":{"description":"The Menu Board code identifier"},"userId":{"description":"The Menu Board owner Id"},"modifiedDt":{"description":"The Menu Board last modified date"},"folderId":{"description":"The Id of the Folder this Menu Board belongs to"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Menu Board"},"groupsWithPermissions":{"description":"A comma separated list of Groups/Users that have permission to this menu Board"}},"type":"object"}}}}
```

## Search Menu Board by ID

> Get the Menu Board object specified by the provided menuId

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"paths":{"/menuboard/{menuId}":{"get":{"tags":["menuBoard"],"summary":"Search Menu Board by ID","description":"Get the Menu Board object specified by the provided menuId","operationId":"menuBoardSearchById","parameters":[{"name":"menuId","in":"path","description":"Numeric ID of the Menu Board to get","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MenuBoard"}}}}}}}},"components":{"schemas":{"MenuBoard":{"description":"Class MenuBoard","properties":{"menuId":{"description":"The Menu Board Id"},"name":{"description":"The Menu Board name"},"description":{"description":"The Menu Board description"},"code":{"description":"The Menu Board code identifier"},"userId":{"description":"The Menu Board owner Id"},"modifiedDt":{"description":"The Menu Board last modified date"},"folderId":{"description":"The Id of the Folder this Menu Board belongs to"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Menu Board"},"groupsWithPermissions":{"description":"A comma separated list of Groups/Users that have permission to this menu Board"}},"type":"object"}}}}
```

## Edit Menu Board

> Edit existing Menu Board

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"paths":{"/menuboard/{menuId}":{"put":{"tags":["menuBoard"],"summary":"Edit Menu Board","description":"Edit existing Menu Board","operationId":"menuBoardEdit","parameters":[{"name":"menuId","in":"path","description":"The Menu Board ID to Edit","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"required":["name"],"properties":{"name":{"description":"Menu Board name","type":"string"},"description":{"description":"Menu Board description","type":"string"},"code":{"description":"Menu Board code identifier","type":"string"},"folderId":{"description":"Menu Board Folder Id","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"successful operation"}}}}}}
```

## Delete Menu Board

> Delete existing Menu Board

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"paths":{"/menuboard/{menuId}":{"delete":{"tags":["menuBoard"],"summary":"Delete Menu Board","description":"Delete existing Menu Board","operationId":"menuBoardDelete","parameters":[{"name":"menuId","in":"path","description":"The Menu Board ID to Delete","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"successful operation"}}}}}}
```

## Copy Menu Board

> Copy a Menu Board and all of its Categories and Products

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"paths":{"/menuboard/copy/{menuId}":{"post":{"tags":["menuBoard"],"summary":"Copy Menu Board","description":"Copy a Menu Board and all of its Categories and Products","operationId":"menuBoardCopy","parameters":[{"name":"menuId","in":"path","description":"The Menu Board ID to copy","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"required":["name"],"properties":{"name":{"description":"Menu Board name","type":"string"},"description":{"description":"Menu Board description","type":"string"},"code":{"description":"Menu Board code identifier","type":"string"}},"type":"object"}}}},"responses":{"201":{"description":"successful operation","headers":{"Location":{"description":"Location of the new record","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MenuBoard"}}}}}}}},"components":{"schemas":{"MenuBoard":{"description":"Class MenuBoard","properties":{"menuId":{"description":"The Menu Board Id"},"name":{"description":"The Menu Board name"},"description":{"description":"The Menu Board description"},"code":{"description":"The Menu Board code identifier"},"userId":{"description":"The Menu Board owner Id"},"modifiedDt":{"description":"The Menu Board last modified date"},"folderId":{"description":"The Id of the Folder this Menu Board belongs to"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Menu Board"},"groupsWithPermissions":{"description":"A comma separated list of Groups/Users that have permission to this menu Board"}},"type":"object"}}}}
```

## Add Menu Board

> Add a new Menu Board

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"paths":{"/menuboard":{"post":{"tags":["menuBoard"],"summary":"Add Menu Board","description":"Add a new Menu Board","operationId":"menuBoardAdd","requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"required":["name"],"properties":{"name":{"description":"Menu Board name","type":"string"},"description":{"description":"Menu Board description","type":"string"},"code":{"description":"Menu Board code identifier","type":"string"},"folderId":{"description":"Menu Board Folder Id","type":"integer"}},"type":"object"}}}},"responses":{"201":{"description":"successful operation","headers":{"Location":{"description":"Location of the new record","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MenuBoard"}}}}}}}},"components":{"schemas":{"MenuBoard":{"description":"Class MenuBoard","properties":{"menuId":{"description":"The Menu Board Id"},"name":{"description":"The Menu Board name"},"description":{"description":"The Menu Board description"},"code":{"description":"The Menu Board code identifier"},"userId":{"description":"The Menu Board owner Id"},"modifiedDt":{"description":"The Menu Board last modified date"},"folderId":{"description":"The Id of the Folder this Menu Board belongs to"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Menu Board"},"groupsWithPermissions":{"description":"A comma separated list of Groups/Users that have permission to this menu Board"}},"type":"object"}}}}
```

## Menu Board Select folder

> Select Folder for Menu Board

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"paths":{"/menuboard/{id}/selectfolder":{"put":{"tags":["menuBoard"],"summary":"Menu Board Select folder","description":"Select Folder for Menu Board","operationId":"menuBoardSelectFolder","parameters":[{"name":"menuId","in":"path","description":"The Menu Board ID","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"required":["folderId"],"properties":{"folderId":{"description":"Folder ID to which this object should be assigned to","type":"integer"}},"type":"object"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MenuBoard"}}}}}}}},"components":{"schemas":{"MenuBoard":{"description":"Class MenuBoard","properties":{"menuId":{"description":"The Menu Board Id"},"name":{"description":"The Menu Board name"},"description":{"description":"The Menu Board description"},"code":{"description":"The Menu Board code identifier"},"userId":{"description":"The Menu Board owner Id"},"modifiedDt":{"description":"The Menu Board last modified date"},"folderId":{"description":"The Id of the Folder this Menu Board belongs to"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Menu Board"},"groupsWithPermissions":{"description":"A comma separated list of Groups/Users that have permission to this menu Board"}},"type":"object"}}}}
```

## Search Menu Board Categories

> Search all Menu Boards Categories this user has access to

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"paths":{"/menuboard/{menuId}/categories":{"get":{"tags":["menuBoard"],"summary":"Search Menu Board Categories","description":"Search all Menu Boards Categories this user has access to","operationId":"menuBoardCategorySearch","parameters":[{"name":"menuId","in":"path","description":"Filter by Menu board Id","required":true,"schema":{"type":"integer"}},{"name":"menuCategoryId","in":"query","description":"Filter by Menu Board Category Id","required":false,"schema":{"type":"integer"}},{"name":"name","in":"query","description":"Filter by name","required":false,"schema":{"type":"string"}},{"name":"code","in":"query","description":"Filter by code","required":false,"schema":{"type":"string"}},{"name":"sortBy","in":"query","description":"Specifies which field the results are sorted by. Used together with sortDir","required":false,"schema":{"type":"string","enum":["menuCategoryId","name","code"]}},{"name":"sortDir","in":"query","description":"Sort direction","required":false,"schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"successful operation","headers":{"X-Total-Count":{"description":"The total number of records","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MenuBoard"}}}}}}}}},"components":{"schemas":{"MenuBoard":{"description":"Class MenuBoard","properties":{"menuId":{"description":"The Menu Board Id"},"name":{"description":"The Menu Board name"},"description":{"description":"The Menu Board description"},"code":{"description":"The Menu Board code identifier"},"userId":{"description":"The Menu Board owner Id"},"modifiedDt":{"description":"The Menu Board last modified date"},"folderId":{"description":"The Id of the Folder this Menu Board belongs to"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Menu Board"},"groupsWithPermissions":{"description":"A comma separated list of Groups/Users that have permission to this menu Board"}},"type":"object"}}}}
```

## Search Menu Board Category by ID

> Get the Menu Board Category object specified by the provided menuCategoryId

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"paths":{"/menuboard/category/{menuCategoryId}":{"get":{"tags":["menuBoard"],"summary":"Search Menu Board Category by ID","description":"Get the Menu Board Category object specified by the provided menuCategoryId","operationId":"menuBoardCategorySearchById","parameters":[{"name":"menuCategoryId","in":"path","description":"Numeric ID of the Menu Board Category to get","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MenuBoardCategory"}}}}}}}},"components":{"schemas":{"MenuBoardCategory":{"description":"Class MenuBoardCategory","properties":{"menuCategoryId":{"description":"The Menu Board Category Id"},"menuId":{"description":"The Menu Board Id"},"name":{"description":"The Menu Board Category name"},"description":{"description":"The Menu Board Category description"},"code":{"description":"The Menu Board Category code identifier"},"mediaId":{"description":"The Menu Board Category associated mediaId"}},"type":"object"}}}}
```

## Copy Menu Board Category

> Copy a Menu Board Category and all of its Products

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"paths":{"/menuboard/category/copy/{menuCategoryId}":{"post":{"tags":["menuBoard"],"summary":"Copy Menu Board Category","description":"Copy a Menu Board Category and all of its Products","operationId":"menuBoardCategoryCopy","parameters":[{"name":"menuCategoryId","in":"path","description":"The Menu Board Category ID to copy","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"required":["name"],"properties":{"name":{"description":"Menu Board Category name","type":"string"},"description":{"description":"Menu Board Category description","type":"string"},"code":{"description":"Menu Board Category code identifier","type":"string"}},"type":"object"}}}},"responses":{"201":{"description":"successful operation","headers":{"Location":{"description":"Location of the new record","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MenuBoardCategory"}}}}}}}},"components":{"schemas":{"MenuBoardCategory":{"description":"Class MenuBoardCategory","properties":{"menuCategoryId":{"description":"The Menu Board Category Id"},"menuId":{"description":"The Menu Board Id"},"name":{"description":"The Menu Board Category name"},"description":{"description":"The Menu Board Category description"},"code":{"description":"The Menu Board Category code identifier"},"mediaId":{"description":"The Menu Board Category associated mediaId"}},"type":"object"}}}}
```

## Add Menu Board Category

> Add a new Menu Board Category

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"paths":{"/menuboard/{menuId}/category":{"post":{"tags":["menuBoard"],"summary":"Add Menu Board Category","description":"Add a new Menu Board Category","operationId":"menuBoardCategoryAdd","parameters":[{"name":"menuId","in":"path","description":"The Menu Board ID to which we want to add this Category to","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"required":["name"],"properties":{"name":{"description":"Menu Board Category name","type":"string"},"mediaId":{"description":"Media ID associated with this Menu Board Category","type":"integer"},"code":{"description":"Menu Board Category code identifier","type":"string"},"description":{"description":"Menu Board Category description","type":"string"}},"type":"object"}}}},"responses":{"201":{"description":"successful operation","headers":{"Location":{"description":"Location of the new record","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MenuBoard"}}}}}}}},"components":{"schemas":{"MenuBoard":{"description":"Class MenuBoard","properties":{"menuId":{"description":"The Menu Board Id"},"name":{"description":"The Menu Board name"},"description":{"description":"The Menu Board description"},"code":{"description":"The Menu Board code identifier"},"userId":{"description":"The Menu Board owner Id"},"modifiedDt":{"description":"The Menu Board last modified date"},"folderId":{"description":"The Id of the Folder this Menu Board belongs to"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Menu Board"},"groupsWithPermissions":{"description":"A comma separated list of Groups/Users that have permission to this menu Board"}},"type":"object"}}}}
```

## Edit Menu Board Category

> Edit existing Menu Board Category

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"paths":{"/menuboard/{menuCategoryId}/category":{"put":{"tags":["menuBoard"],"summary":"Edit Menu Board Category","description":"Edit existing Menu Board Category","operationId":"menuBoardCategoryEdit","parameters":[{"name":"menuCategoryId","in":"path","description":"The Menu Board Category ID to Edit","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"required":["name"],"properties":{"name":{"description":"Menu Board name","type":"string"},"mediaId":{"description":"Media ID from CMS Library to associate with this Menu Board Category","type":"integer"},"code":{"description":"Menu Board Category code identifier","type":"string"},"description":{"description":"Menu Board Category description","type":"string"}},"type":"object"}}}},"responses":{"204":{"description":"successful operation"}}}}}}
```

## Delete Menu Board Category

> Delete existing Menu Board Category

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"paths":{"/menuboard/{menuCategoryId}/category":{"delete":{"tags":["menuBoard"],"summary":"Delete Menu Board Category","description":"Delete existing Menu Board Category","operationId":"menuBoardCategoryDelete","parameters":[{"name":"menuCategoryId","in":"path","description":"The Menu Board Category ID to Delete","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"successful operation"}}}}}}
```

## Search Menu Board Products

> Search all Menu Boards Products this user has access to

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"paths":{"/menuboard/{menuCategoryId}/products":{"get":{"tags":["menuBoard"],"summary":"Search Menu Board Products","description":"Search all Menu Boards Products this user has access to","operationId":"menuBoardProductsSearch","parameters":[{"name":"menuCategoryId","in":"path","description":"Filter by Menu Board Category Id","required":true,"schema":{"type":"integer"}},{"name":"menuId","in":"query","description":"Filter by Menu board Id","required":false,"schema":{"type":"integer"}},{"name":"name","in":"query","description":"Filter by name","required":false,"schema":{"type":"string"}},{"name":"code","in":"query","description":"Filter by code","required":false,"schema":{"type":"string"}},{"name":"sortBy","in":"query","description":"Specifies which field the results are sorted by. Used together with sortDir","required":false,"schema":{"type":"string","enum":["menuProductId","name","price","displayOrder","availability"]}},{"name":"sortDir","in":"query","description":"Sort direction","required":false,"schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"successful operation","headers":{"X-Total-Count":{"description":"The total number of records","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MenuBoard"}}}}}}}}},"components":{"schemas":{"MenuBoard":{"description":"Class MenuBoard","properties":{"menuId":{"description":"The Menu Board Id"},"name":{"description":"The Menu Board name"},"description":{"description":"The Menu Board description"},"code":{"description":"The Menu Board code identifier"},"userId":{"description":"The Menu Board owner Id"},"modifiedDt":{"description":"The Menu Board last modified date"},"folderId":{"description":"The Id of the Folder this Menu Board belongs to"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Menu Board"},"groupsWithPermissions":{"description":"A comma separated list of Groups/Users that have permission to this menu Board"}},"type":"object"}}}}
```

## Search Menu Board Product by ID

> Get the Menu Board Product object specified by the provided menuProductId

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"paths":{"/menuboard/product/{menuProductId}":{"get":{"tags":["menuBoard"],"summary":"Search Menu Board Product by ID","description":"Get the Menu Board Product object specified by the provided menuProductId","operationId":"menuBoardProductSearchById","parameters":[{"name":"menuProductId","in":"path","description":"Numeric ID of the Menu Board Product to get","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MenuBoardProduct"}}}}}}}},"components":{"schemas":{"MenuBoardProduct":{"description":"Class MenuBoardProduct","properties":{"menuProductId":{"description":"The Menu Board Product Id"},"menuCategoryId":{"description":"The Menu Board Category Id"},"menuId":{"description":"The Menu Board Id"},"name":{"description":"The Menu Board Category name"},"price":{"description":"The Menu Board Product price"},"description":{"description":"The Menu Board Product description"},"code":{"description":"The Menu Board Product code identifier"},"displayOrder":{"description":"The Menu Board Product display order, used for sorting"},"availability":{"description":"The Menu Board Product availability"},"allergyInfo":{"description":"The Menu Board Product allergy information"},"calories":{"description":"The Menu Board Product allergy information"},"mediaId":{"description":"The Menu Board Product associated mediaId"},"productOptions":{"description":"The Menu Board Product array of options","type":"array","items":{"type":"string"}}},"type":"object"}}}}
```

## Add Menu Board Product

> Add a new Menu Board Product

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"paths":{"/menuboard/{menuCategoryId}/product":{"post":{"tags":["menuBoard"],"summary":"Add Menu Board Product","description":"Add a new Menu Board Product","operationId":"menuBoardProductAdd","parameters":[{"name":"menuCategoryId","in":"path","description":"The Menu Board Category ID to which we want to add this Product to","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"required":["name","displayOrder"],"properties":{"name":{"description":"Menu Board Product name","type":"string"},"description":{"description":"Menu Board Product description","type":"string"},"price":{"description":"Menu Board Product price","type":"number"},"allergyInfo":{"description":"Menu Board Product allergyInfo","type":"string"},"calories":{"description":"Menu Board Product calories","type":"integer"},"displayOrder":{"description":"Menu Board Product Display Order, used for sorting","type":"integer"},"availability":{"description":"Menu Board Product availability","type":"integer"},"mediaId":{"description":"Media ID from CMS Library to associate with this Menu Board Product","type":"integer"},"code":{"description":"Menu Board Product code","type":"string"},"productOptions":{"description":"An array of optional Product Option names","type":"array","items":{"type":"string"}},"productValues":{"description":"An array of optional Product Option values","type":"array","items":{"type":"string"}}},"type":"object"}}}},"responses":{"201":{"description":"successful operation","headers":{"Location":{"description":"Location of the new record","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MenuBoard"}}}}}}}},"components":{"schemas":{"MenuBoard":{"description":"Class MenuBoard","properties":{"menuId":{"description":"The Menu Board Id"},"name":{"description":"The Menu Board name"},"description":{"description":"The Menu Board description"},"code":{"description":"The Menu Board code identifier"},"userId":{"description":"The Menu Board owner Id"},"modifiedDt":{"description":"The Menu Board last modified date"},"folderId":{"description":"The Id of the Folder this Menu Board belongs to"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Menu Board"},"groupsWithPermissions":{"description":"A comma separated list of Groups/Users that have permission to this menu Board"}},"type":"object"}}}}
```

## Edit Menu Board Product

> Edit existing Menu Board Product

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"paths":{"/menuboard/{menuProductId}/product":{"put":{"tags":["menuBoard"],"summary":"Edit Menu Board Product","description":"Edit existing Menu Board Product","operationId":"menuBoardProductEdit","parameters":[{"name":"menuProductId","in":"path","description":"The Menu Board Product ID to Edit","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"required":["name","displayOrder"],"properties":{"name":{"description":"Menu Board Product name","type":"string"},"description":{"description":"Menu Board Product description","type":"string"},"price":{"description":"Menu Board Product price","type":"number"},"allergyInfo":{"description":"Menu Board Product allergyInfo","type":"string"},"calories":{"description":"Menu Board Product calories","type":"integer"},"displayOrder":{"description":"Menu Board Product Display Order, used for sorting","type":"integer"},"availability":{"description":"Menu Board Product availability","type":"integer"},"mediaId":{"description":"Media ID from CMS Library to associate with this Menu Board Product","type":"integer"},"code":{"description":"Menu Board Product code","type":"string"},"productOptions":{"description":"An array of optional Product Option names","type":"array","items":{"type":"string"}},"productValues":{"description":"An array of optional Product Option values","type":"array","items":{"type":"string"}}},"type":"object"}}}},"responses":{"200":{"description":"successful operation"}}}}}}
```

## Delete Menu Board Product

> Delete existing Menu Board Product

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"menuBoard","description":"Menu Boards - feature preview, please do not use in production."}],"servers":[{"url":"/api"}],"paths":{"/menuboard/{menuProductId}/product":{"delete":{"tags":["menuBoard"],"summary":"Delete Menu Board Product","description":"Delete existing Menu Board Product","operationId":"menuBoardProductDelete","parameters":[{"name":"menuProductId","in":"path","description":"The Menu Board Product ID to Delete","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"successful operation"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.xibosignage.com/developer/integrate/openapi/menu-board.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.