Skip to content

createAdminAppearanceThemeActivate ​

Points one or more channels at a theme. Each channel keeps its own theme, so activating on one leaves the others alone.

Sections built for a channel's previous theme are left in place and stop being drawn. Query adminAppearanceThemeImpact first to report that before switching.

Input fields ​

FieldTypeRequiredDescription
codeStringYesTheme code to activate. Must be installed.
channelIdsIterableYesChannels to point at the theme.

Payload fields ​

FieldTypeDescription
codeStringActivated theme code.
activatedOnIterableChannels that were switched, each { id, name }.
messageStringConfirmation text.

Use cases ​

  • Roll a theme out to one channel first — send a single channel ID, verify the storefront, then send the rest.

Best practices ​

  • Do not select id on the payload. This result is an action outcome with no resource route of its own; code identifies it.
  • The theme must be installed, not merely listed — an available theme is refused.
  • Build the sections before switching a live channel. A channel pointed at a theme it has no sections for renders that theme's own defaults.

Permissions ​

Requires appearance.themes.activate.

Released under the MIT License.