.dev
Partner Dashboard

Preview a builder page ​

Last updated View as Markdown

Endpoint: https://api.youcan.shop/pages/{id}/builder/preview

Method: POST

Returns a link to a preview of the page with the content you send. The page itself does not change.

Required Scopes ​

  • read-pages

Parameters ​

The same as Update a builder page. When you do not send settings or sections, the preview uses the current value.

Response ​

[200]

json
{
    "url": "https://my-store.youcan.store/pages/8b6d1a24-5c4e-4a5f-9d1e-0f2c3b4a5d6e/preview?draft=6f1e2d3c",
    "expires_at": "2026-10-09T13:00:00+00:00",
    "ignored": []
}

The link works for 60 minutes.

[422] Unprocessable Entity

The same validation errors as Update a builder page.