Update Section
Writes a section's published values — what the storefront draws immediately. To hold a change back until publishing, use Stage edits instead.
Endpoint
| Method | Path | Purpose |
|---|---|---|
PUT | /api/admin/appearance/sections/{id} | Update a section |
Path parameters
| Parameter | Description |
|---|---|
id | Section ID. |
Query parameters
| Parameter | Description |
|---|---|
locale | Locale the options belong to. Must be one the channel runs; otherwise the app locale, then the channel's first locale. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Section name. |
type | string | Yes | One of the six section types. |
sortOrder | integer | Yes | Published position. |
channelId | integer | Yes | Channel the section belongs to. |
themeCode | string | Yes | Theme the section belongs to. |
status | boolean | No | Published on/off. Keeps the current value when omitted. |
options | object | No | Published content for the locale. Keeps the current content when omitted. |
Response fields
The updated section, same shape as Get section, with message set.
Use cases
- Rename or reposition without touching content — send the five required fields and leave
optionsout. - Publish content straight away — send
optionsfor a section whose copy is already final, skipping the draft cycle.
Best practices
- Send every required field, including the ones you are not changing. The body is a full form:
name,type,sortOrder,channelIdandthemeCodeare validated on every call, and a missing one is a422rather than a no-op. optionswrites one locale. Repeat the call per locale with a differentlocaleto fill the rest.- Switching a section to
footer_linksfollows the same one-per-channel rule as creating one, so a channel that already has a footer rejects the change with422.
Errors
| Status | When |
|---|---|
404 | No section with this ID. |
422 | A required field missing, an unknown type, an unknown channelId, or a second footer_links section. |
Permissions
Requires appearance.sections.edit.

