SharePoint Online: Update List Title, Description, Quick Launch Navigation Properties using PowerShell

Requirement: Set Title, Description, and Quick Launch Navigation settings in a SharePoint Online List

How to Update List Title, Description, and Quick Launch Navigation Settings in SharePoint Online?

In this blog post, we will show you how to change the list settings in SharePoint Online. We will cover how to modify the list properties, such as renaming a list, setting the list description, and choosing whether the list should appear in the quick launch navigation.

To set the list title, description, and quick launch navigation options in SharePoint Online, follow these steps:

  • Navigate to your target list or library. Click on Settings Icon and then “Library Settings” (In Classic SharePoint, Under “List” tab, Click on “List Settings” button in the ribbon)
    update sharepoint online list using powershell
  • In the List or Library settings page, Click on “List name, description and navigation” link under General Settings.
    Set sharepoint online list Title using powershell
  • General Settings page, You can update the Title of the list, Description for the list and the option to show or hide the list in Quick launch navigation. Click on “Save” to commit your changes.
    set sharepoint online list title, description, quick lanuch settings powershell

PowerShell to Set List Title, Description and Quick Launch Navigation Settings

Here is the PowerShell script to update list settings:

#Load SharePoint CSOM Assemblies
Add-Type -Path "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.dll"
Add-Type -Path "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.Runtime.dll"
   
#Config Parameters
$SiteURL= "https://crescent.sharepoint.com/"
$ListName="Project Docs"
 
#Setup Credentials to connect
$Cred = Get-Credential
$Cred = New-Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($Cred.UserName,$Cred.Password)
 
Try {
    #Setup the context
    $Ctx = New-Object Microsoft.SharePoint.Client.ClientContext($SiteURL)
    $Ctx.Credentials = $Cred
   
    #Get the web and List
    $Web=$Ctx.Web
    $List=$web.Lists.GetByTitle($ListName)
  
    #Set List Title, Description and Quick launch Navigation properties
    $List.Title="Project Documentation"
    $List.Description="Document Repository to Store Upcoming Project Artifacts"
    $List.OnQuickLaunch=$True
    $List.Update()
    
    $Ctx.ExecuteQuery()

    Write-host -f Green "List Properties Updated!"
}
Catch {
    write-host -f Red "Error Setting List Properties!" $_.Exception.Message
}

PnP PowerShell to Set List Title, Description and On Quick Launch Properties:

Are you looking to change your SharePoint Online list settings using PowerShell? Here you go:

#Config Variables
$SiteURL = "https://Crescent.sharepoint.com/sales"
$ListName = "Project Metrics"
#List Properties to update
$ListTitle = "Project Metrics V2"
$ListDescription ="List to capture Project Metrics Version 2"
$OnQuickLaunch = $True

#Connect to PnP Online
Connect-PnPOnline -Url $SiteURL -Credentials (Get-Credential)

#Get the context
$Context = Get-PnPContext

#Get the List
$List = Get-PnPList -Identity $ListName

#Set List Title, Description and On Quick Launch Properties
$List.Title =$ListTitle
$List.Description = $ListDescription
$List.OnQuickLaunch = $OnQuickLaunch
$List.Update() 
$Context.ExecuteQuery()

You can also use the Set-PnPList cmdlet to set these properties. E.g.,

Set-PnPList -Identity "Documents" -Title "Team Docs" -Description "Team Documents"

Salaudeen Rajack

Salaudeen Rajack is a SharePoint Architect with Two decades of SharePoint Experience. He loves sharing his knowledge and experiences with the SharePoint community, through his real-world articles!

One thought on “SharePoint Online: Update List Title, Description, Quick Launch Navigation Properties using PowerShell

  • Is it possible to add a link or mailto clickable button to a SPO List description box?

    Reply

Leave a Reply