updateMenu

Requires permission settings:appearance:update.

Updates a menu. A parent, when given, must exist in the organization. Needs the appearance settings update permission.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation UpdateMenu($input: UpdateMenuInput!) {
  updateMenu(input: $input) {
    id
    name
    createdAt
    deletedAt
    deletedBy
    description
    children {
      id
      name
      createdAt
      deletedAt
      deletedBy
      description
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation UpdateMenu($input: UpdateMenuInput!) {\n  updateMenu(input: $input) {\n    id\n    name\n    createdAt\n    deletedAt\n    deletedBy\n    description\n    children {\n      id\n      name\n      createdAt\n      deletedAt\n      deletedBy\n      description\n    }\n  }\n}",
  "variables": {
    "input": {
      "id": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "id": "string"
  }
}

Response:

{
  "data": {
    "updateMenu": {
      "id": "id",
      "name": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "deletedAt": "2025-01-15T00:00:00Z",
      "deletedBy": "string",
      "description": "string",
      "children": [
        {
          "id": "id",
          "name": "string",
          "createdAt": "2025-01-15T00:00:00Z",
          "deletedAt": "2025-01-15T00:00:00Z",
          "deletedBy": "string",
          "description": "string"
        }
      ]
    }
  }
}

updateMenu(
  input: UpdateMenuInput!
): Menu!

Arguments

updateMenu.input ● UpdateMenuInput! non-null input

The ID of the menu and the fields to change.

Type

Menu object

A menu item.