Menu Management

Update menu keeping the same revision

put/menuManagement/orgs/{orgId}/menus/{menuId}

Request

  • Base URL: https://api.flipdish.co (the document declares no server; this is the origin it was published from)
  • URL: https://api.flipdish.co/menuManagement/orgs/{orgId}/menus/{menuId}
  • Auth: HTTP bearer

Path parameters

orgIdstring required

Organization ID in standard format

Example:org123
menuIdstring required

Menu ID

Example:123e4567-e89b-12d3-a456-426614174000

Request body

namestring required

Name of the menu

descriptionstring nullable

Description of the menu

metadatastring nullable

Metadata as json string

integrationNamestring nullable

Name of the external integration associated with this menu (e.g. PixelPoint, Lightspeed, Captiva). Null means no integration.

typestring required

Type of the menu

idstring uuid required

ID of the menu (required for updates)

Example request

{
  "name": "Main Menu",
  "description": "This is a note",
  "integrationName": "PixelPoint",
  "type": "Store",
  "categories": [],
  "modifiers": [],
  "categoryGroups": []
}

Response

Menu updated successfully

Example response

{
  "data": {
    "name": "Main Menu",
    "description": "This is a note",
    "integrationName": "PixelPoint",
    "type": "Store",
    "orgId": "org123",
    "createdAt": "2021-01-01T16:00:00Z",
    "updatedBy": "user@example.com",
    "updatedAt": "2021-01-01T16:00:00Z",
    "revisionId": 1,
    "categories": [],
    "modifiers": [],
    "categoryGroups": []
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.