Skip to navigation
RESTAdminContentWidgetsWidget Template

Render Widget Template

Render a widget template and return the widget html.

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
dataobjectOptional

Errors

404
Not Found Error
422
Unprocessable Entity Error