Stage Status
Stages a section on or off. Like every other edit, it reaches the storefront only when the theme is published.
Endpoint
| Method | Path | Purpose |
|---|---|---|
POST | /api/admin/appearance/sections/{id}/status | Stage a section on or off |
Path parameters
| Parameter | Description |
|---|---|
id | Section ID. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
status | boolean | Yes | true to show the section once published, false to hide it. |
Response fields
| Field | Type | Description |
|---|---|---|
sectionId | integer | Section the status belongs to. |
draftStatus | boolean | null | The staged state. |
hasDraft | boolean | Whether the section now holds any staged edit. |
message | string | Confirmation text. |
Use cases
- Take a section down at the next publish — stage
false, keep the content, publish when ready. Nothing is deleted, so stagingtruelater brings it back exactly as it was.
Best practices
- The published
statusdoes not move here. Reading the section back still shows the oldstatus; the new value sits indraftStatusuntil publish, which is what lets a merchant stage a takedown without it going live mid-edit. - To switch a section on or off immediately, send
statuson Update section instead — that writes the published value directly.
Errors
| Status | When |
|---|---|
404 | No section with this ID. |
422 | status missing. |
Permissions
Requires appearance.sections.edit.