Skip to content

Create Theme Customization

Create a theme customization block. This is a step-1 create: it sets the block's scalar fields only, and the block starts with empty translations. Add the per-locale content afterwards with the Update mutation.

TIP

See the Themes overview for what each type renders. The type is fixed at creation and cannot be changed later.

Operation

OperationTypePurpose
createAdminSettingsThemeMutationCreate a theme customization block

Input

FieldTypeRequiredPurpose
nameStringyesInternal label shown in the admin grid.
typeStringyesThe block kind — one of product_carousel, category_carousel, static_content, image_carousel, footer_links, services_content.
sortOrderIntyesPosition relative to other blocks on the same channel.
channelIdIntyesThe sales channel this block is bound to.
themeCodeStringyesThe theme code this block belongs to (e.g. default).
statusBooleannotrue = active, false = inactive.

Quirks

  • Per-locale content (options) is not accepted here — set it with the Update mutation.
  • Image / file fields are path strings only; binary upload is not available — use the admin panel to upload files.

Permission: settings.themes.create. All operations require an admin Bearer token — see Authentication.

Released under the MIT License.