Skip to content

updateAdminAppearanceSection

Writes a section's published values — what the storefront draws immediately. To hold a change back until publishing, use createAdminAppearanceSectionDraft instead.

Input fields

FieldTypeRequiredDescription
idIDYesSection IRI.
nameStringYesSection name.
typeStringYesOne of the six section types.
sortOrderIntYesPublished position.
channelIdIntYesChannel the section belongs to.
themeCodeStringYesTheme the section belongs to.
statusBooleanNoPublished on/off. Keeps the current value when omitted.
localeStringNoLocale the options belong to. Falls back to the channel locale.
optionsIterableNoPublished content for the locale. Keeps the current content when omitted.

Payload fields

The updated section, same fields as adminAppearanceSection, with message set.

Use cases

  • Rename or reposition without touching content — send the required fields and leave options out.
  • Publish content straight away — send options for copy that is already final, skipping the draft cycle.

Best practices

  • Send every required field, including the ones you are not changing. The input is a full form; a missing one is a validation error rather than a no-op.
  • options writes one locale. Repeat the mutation per locale with a different locale.
  • Switching a section to footer_links follows the one-per-channel rule and is rejected when the channel already has a footer.

Permissions

Requires appearance.sections.edit.

Released under the MIT License.