Preview page-builder canvas edits

POST 
/openapi/2026-01/themes/page-builder/update

Apply edit operations (ops) to the given canvas data and return the edited canvas data, the rendered HTML, the canvas text snapshot, and translations. Nothing is saved.

Request

application/json

Body

Bodyrequired

schemaobjectrequired

Full canvas data (page-builder ProjectData)

opsobject[]

Operations to apply; defaults to re-export

Example

json

{
  "schema": {},
  "ops": [
    {}
  ]
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

schemaobject

Full canvas data after the edits

textstring

New canvas text snapshot after applying ops

htmlstring

Rendered liquid/html

translationobject[]

i18n entries, each {key,label,type,value}

failuresobject[]

Ops that failed to apply

timingsobject

Timing metrics

Example

json

{
  "code": "string",
  "message": "string",
  "data": {
    "schema": {},
    "text": "string",
    "html": "string",
    "translation": [
      {}
    ],
    "failures": [
      {}
    ],
    "timings": {}
  }
}