Add content type to an SharePoint Online list with PowerShell

This is part 8 of 10 where we will be adding a content type to an SharePoint Online list with PowerShell. This is part of the following series:

We will be collecting all available web templates in part 1 so we can use this to create a new site in part 2. In part 3 we will be creating a web for the newly created site. We then want to create a couple of site columns in part 4 which we will combine to a content type in part 5. This content type will be added (part 8) to our newly created document library in part 7 using a list template from part 6. After everything is set we will be setting the view in part 9 for this list to show the added columns we got from adding the content type. We only want to set permissions for myself so I’ll will be breaking the inheritance and setting permissions in part 10.

Add content type to an SharePoint Online list

This script will update the library to enable multiple content types and then add the newly created content type. We will first start by opening the SharePoint Online Management Shell as administrator which can be downloaded at https://www.microsoft.com/en-us/download/details.aspx?id=35588.

image

You will need to change the first variables to match your Office 365 tenant and copy this bit to PowerShell.

function update-spOnlineListWithContentType {
 #variables that needs to be set before starting the script
 $siteURL = "https://spfire.sharepoint.com/sites/BlogDemo"
 $adminUrl = "https://spfire-admin.sharepoint.com"
 $userName = "mpadmin@spfire.onmicrosoft.com"
 $listName = "finance"
 $ctID = "0x010100DD6BABAC17A5504DB29949148A37DA61"
 
 # Let the user fill in their password in the PowerShell window
 $password = Read-Host "Please enter the password for $($userName)" -AsSecureString
 
 # set SharePoint Online credentials
 $SPOCredentials = New-Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($userName, $password)
  
 # Creating client context object
 $context = New-Object Microsoft.SharePoint.Client.ClientContext($siteURL)
 $context.credentials = $SPOCredentials
 $list = $context.web.lists.GetByTitle($listName)
 $ct = $context.web.contenttypes.getbyid($ctID)
 $context.load($ct)
 $context.load($list)
 $context.load($list.contenttypes)
 
 #send the request containing all operations to the server
 try{
  $context.executeQuery()
  write-host "info: ClientContext object executed" -foregroundcolor green
 }
 catch{
  write-host "info: Error executing ClientContext object" -foregroundcolor red
 }
 
 #enable multiple content types for the library and add the content type
 $list.ContentTypesEnabled = $true
 $AddCT = $list.ContentTypes.AddExistingContentType($ct)
 $list.update()
 write-host "info: Enabled multiple content types"
 
 #send the request containing all operations to the server
 try{
  $context.executeQuery()
  write-host "info: added the content type to the list" -foregroundcolor green
 }
 catch{
  write-host "info: $($_.Exception.Message)" -foregroundcolor red
 }
}
update-spOnlineListWithContentType

image

You will be asked to enter the password and press enter

image

Verify if the content type has been added to the specified list / library

image

Tips

You can find the Content Type ID with PowerShell or navigate to site settings and then click on content types and then click on the content type you wish to be the parent

image

You can find the ID in the URL after ctype=<ContentTypeID>

3 thoughts on “Add content type to an SharePoint Online list with PowerShell

  1. Hi I am using this script. It works fine if you list exist in the site collection level as the Content type is also on Site Level.
    Now I want to add site content type in Subsite list. Please advice what I can do. It gives me this error.
    Exception calling “AddExistingContentType” with “1” argument(s): “The object
    is used in the context different from the one associated with the object.”

  2. Hi I am using this script. It works fine if you list exist in the site collection level as the Content type is also on Site Level.
    Now I want to add site content type in Subsite list. Please advice what I can do. It gives me this error.
    Exception calling “AddExistingContentType” with “1” argument(s): “The object
    is used in the context different from the one associated with the object.”

  3. This worked beautifully in my use case. Set it up inside of a foreach loop to add a content type to 116 lists in an SP site. Many thanks!

Leave a Reply

Your email address will not be published. Required fields are marked *