Skip to content

Activate Theme

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

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

Endpoint

MethodPathPurpose
POST/api/admin/appearance/themes/{code}/activateActivate a theme on channels

Path parameters

ParameterDescription
codeTheme code to activate. Must be installed.

Request body

FieldTypeRequiredDescription
channelIdsarray of integersYesChannels to point at the theme.

Response fields

FieldTypeDescription
codestringActivated theme code.
activatedOnarrayChannels 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

  • The theme must be installed, not merely listed. An available theme answers 404 here; check isInstalled on the theme before offering activation.
  • Build the sections before switching a live channel. A channel pointed at a theme it has no sections for renders the theme's own defaults, so create and publish sections for the target theme first.

Errors

StatusWhen
404Unknown theme code, or the theme is not installed.
422channelIds missing, or naming a channel that does not exist.

Permissions

Requires appearance.themes.activate.

Released under the MIT License.