For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
      • Overview
        • Abandoned Cart Emails
        • Custom Template Associations
        • Email Templates
        • Pages
        • Marketing
        • Store Content
        • Themes
        • Widgets
              • GETList Widget Templates
              • POSTCreate Widget Template
              • POSTRender Widget Template
              • GETGet Widget Template
              • PUTUpdate Widget Template
              • DELDelete Widget Template
        • Page Widgets
      • Payments
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
RESTAdminContentWidgetsWidget Template

Render Widget Template

POST
https://api.bigcommerce.com/stores/:store_hash/v3/content/widget-templates/:uuid/preview
POST
/stores/:store_hash/v3/content/widget-templates/:uuid/preview
$curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/content/widget-templates/uuid/preview \
>     -H "X-Auth-Token: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "data": {
3    "html": "<div class=\"widget-container\"><h2>Featured Products</h2><ul><li>Product 1</li><li>Product 2</li><li>Product 3</li></ul></div>"
4  }
5}
Render a widget template and return the widget html.
Was this page helpful?
Previous

Create Widget Template

Next

Get Widget Template

Built with

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
Contentmodifystore_v2_content
Contentread-onlystore_v2_content_read_only

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

Path parameters

uuidstringRequiredformat: "uuid"
The identifier for a specific template.
store_hashstringRequired
Permanent ID of the BigCommerce store.

Request

This endpoint expects an object.
widget_configurationobjectOptional
The JSON data that populates the template.

Response

Success
dataobject

Errors

404
Not Found Error
422
Unprocessable Entity Error