Skip to content

spo sitedesign set

Updates a site design with new values

Usage

spo sitedesign set [options]

Options

Option Description
--help output usage information
-i, --id <id> The ID of the site design to update
-t, --title [title] The new display name of the updated site design
-w, --webTemplate [webTemplate] The new template to add the site design to. Allowed values TeamSite
-s, --siteScripts [siteScripts] Comma-separated list of new site script IDs. The scripts will run in the order listed
-d, --description [description] The new display description of updated site design
-m, --previewImageUrl [previewImageUrl] The new URL of a preview image. If none is specified SharePoint will use a generic image
-a, --previewImageAltText [previewImageAltText] The new alt text description of the image for accessibility
-v, --version [version] The new version number for the site design
--isDefault [isDefault] Set to true if the site design is applied as the default site design
-o, --output [output] Output type. json|text. Default text
--verbose Runs command with verbose logging
--debug Runs command with debug logging

Important

Before using this command, log in to a SharePoint Online site, using the spo login command.

Remarks

To update a site design, you have to first log in to a SharePoint site using the spo login command, eg. spo login https://contoso.sharepoint.com.

If you had previously set the isDefault option to true, and wish for it to remain true, you must pass in this option again or it will be reset to false.

When specifying IDs of site scripts to use with your site design, ensure that the IDs refer to existing site scripts or provisioning sites using the design will lead to unexpected results.

Examples

Update the site design title and version

spo sitedesign set --id 9b142c22-037f-4a7f-9017-e9d8c0e34b98 --title "Contoso site design" --version 2

Update the site design to be the default design for provisioning modern communication sites

spo sitedesign set --id 9b142c22-037f-4a7f-9017-e9d8c0e34b98 --webTemplate CommunicationSite  --isDefault true

More information