Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,73 @@ Creates a new custom theme, or overwrites an existing theme to modify its settin

## SYNTAX

### NewThemeSet
```
Add-SPOTheme [-Identity] <SpoThemePipeBind> -Palette <SpoThemePalettePipeBind> -IsInverted <Boolean>
[-Overwrite] [<CommonParameters>]
Add-SPOTheme
[-Identity] <SpoThemePipeBind>
-ColorPairs <SpoThemeColorPairPipeBind>
[-Overwrite]
[<CommonParameters>]
```

### LegacyThemeSet
```
Add-SPOTheme
[-Identity] <SpoThemePipeBind>
-Palette <SpoThemePalettePipeBind>
-IsInverted <Boolean>
[-Overwrite]
[<CommonParameters>]
```

## DESCRIPTION
This cmdlet creates a new theme or updates an existing theme. The color pairs settings can be passed as a hash table, while the color palette settings can be passed as either a hash table or a dictionary.

Adding a theme does not automatically apply it to any site. Instead, the theme becomes available in the list of themes under the **Change the look** option for modern SharePoint pages.

Choose the appropriate parameter set based on whether you're working with a legacy or modern theme format. For details about the new theme format, see [Site theme](/sharepoint/site-theme).

> [!NOTE]
> In multi-geo environments, themes added by an administrator in the primary geography are automatically propagated and available across the organization. This cmdlet is not supported for administrators in satellite geographies.

The **Add-SPOTheme** cmdlet creates a new theme or updates an existing theme. The color palette settings can be passed as either a hash table or a dictionary.
## Examples

Adding a theme does not apply the theme to any sites. It adds the theme to your tenant store, and then the theme is available in the list of themes under the **Change the look** option for modern pages.
### Example 1:

Copy link
Contributor

@samkabue samkabue Sep 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

description comes AFTER the example #Closed

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

update other examples too

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

## EXAMPLES
```powershell
$colorPairs = @{
light = @(
@{ "accentColor": "#03787C"; "backgroundColor": "#FFFFFF" }
@{ "accentColor": "#FFFFFF"; "backgroundColor": "#03787C" }
@{ "accentColor": "#E3FFFD"; "backgroundColor": "#03787C" }
@{ "accentColor": "#03787C"; "backgroundColor": "#E3FFFD" }
@{ "accentColor": "#FFF9E3"; "backgroundColor": "#03787C" }
@{ "accentColor": "#03787C"; "backgroundColor": "#FFF9E3" }
@{ "accentColor": "#03787C"; "backgroundColor": "#F5F5F5" }
@{ "accentColor": "#242424"; "backgroundColor": "#F5F5F5" }
@{ "accentColor": "#155473"; "backgroundColor": "#FFFFFF" }
@{ "accentColor": "#FFFFFF"; "backgroundColor": "#155473" }
@{ "accentColor": "#155473"; "backgroundColor": "#E3FFFD" }
@{ "accentColor": "#E3FFFD"; "backgroundColor": "#155473" }
@{ "accentColor": "#FFF9E3"; "backgroundColor": "#155473" }
@{ "accentColor": "#155473"; "backgroundColor": "#FFF9E3" }
)
}

Add-SPOTheme -Identity "Teal Theme" -ColorPairs $colorPairs
```

This example creates a theme named `"Teal Theme"` with color pair settings in various shades of teal.

### Example 2:

```powershell
Add-SPOTheme -Identity "Teal Theme" -ColorPairs $colorPairs -Overwrite
```

### Example 1
To update an existing theme in the new format, modify the color settings using the same syntax as when creating a theme. Add the `-Overwrite` flag to the Add-SPOTheme cmdlet.

In this example, a new theme named `"Custom Cyan"` is created, with color palette settings that are various shades of cyan. Note that the settings are passed as a hash table.
### Example 3:

```powershell
$themepalette = @{
Expand Down Expand Up @@ -67,17 +118,19 @@ $themepalette = @{
Add-SPOTheme -Identity "Custom Cyan" -Palette $themepalette -IsInverted $false
```

In this example, a theme named `"Custom Cyan"` is created, with color palette settings that are various shades of cyan. Note that the settings are passed as a hash table.

> [!NOTE]
> Prior to the December 2017 release of the SPO Management Shell, the **Add-SPOTheme** cmdlet required that color palette settings be passed as a dictionary. We recommend that you use the latest version of the SPO Management Shell, or use the `HashToDictionary` function to convert a hash table to a dictionary if needed.

### Example 2

If you want to update an existing theme (to modify some of its color settings, for example), use the same syntax as shown previously, but add the `-Overwrite` flag to the **Add-SPOTheme** cmdlet.
### Example 4: Overwrite a legacy format theme

```powershell
Add-SPOTheme -Identity "Custom Cyan" -Palette $themepalette -IsInverted $false -Overwrite
```

To update an existing legacy format theme and modify its color settings, use the same syntax as when creating the theme. Add the `-Overwrite` flag to the Add-SPOTheme cmdlet.

## PARAMETERS

### -Identity
Expand All @@ -98,34 +151,34 @@ Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```

### -IsInverted
### -Overwrite

> Applicable: SharePoint Online

Specifies whether the theme is inverted, with a dark background and a light foreground.
Overwrites a theme of the same name in case it exists.

```yaml
Type: System.Boolean
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: None

Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Overwrite
### -ColorPairs

> Applicable: SharePoint Online

Overwrites a theme of the same name in case it exists.
Specifies the theme's color pairs using a hash table of slot values. Supports up to 16 color pairs.

```yaml
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: None
Type: Microsoft.Online.SharePoint.PowerShell.SpoThemeColorPairPipeBind
Parameter Sets: NewThemeSet
Aliases:

Required: False
Position: Named
Expand All @@ -138,14 +191,14 @@ Accept wildcard characters: False

> Applicable: SharePoint Online

Specifies the palette of colors in the theme, as a dictionary of theme slot values.
Specifies the palette of colors in the theme, as a dictionary or hash table of theme slot values.

```yaml
Type: Microsoft.Online.SharePoint.PowerShell.SpoThemePalettePipeBind
Parameter Sets: (All)
Parameter Sets: LegacyThemeSet
Aliases:

Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Expand All @@ -155,6 +208,24 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).

### -IsInverted

> Applicable: SharePoint Online

Specifies whether the theme is inverted, with a dark background and a light foreground.

```yaml
Type: System.Boolean
Parameter Sets: LegacyThemeSet
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

## INPUTS

### Microsoft.Online.SharePoint.PowerShell.SpoThemePipeBind
Expand All @@ -166,3 +237,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## NOTES

## RELATED LINKS
[Site theme](/sharepoint/site-theme)