Update Widget

PUT

https://api.bigcommerce.com/stores/:store_hash/v3/content/widgets/:uuid

PUT

/stores/:store_hash/v3/content/widgets/:uuid

curl -X PUT https://api.bigcommerce.com/stores/store_hash/v3/content/widgets/uuid \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "data": {
    "channel_id": 1,
    "date_created": "2020-12-21T19:54:16.406Z",
    "date_modified": "2020-12-21T19:54:16.406Z",
    "description": "",
    "name": "Header Images",
    "uuid": "1f05183e-dfa4-4583-af28-250b47e177b2",
    "version_uuid": "c863f77b-e5b4-4462-a9ed-2aff9005140e",
    "widget_configuration": {
      "_": {
        "id": "1f05183e-dfa4-4583-af28-250b47e177b2"
      },
      "images": [
        {
          "image_source": "https://cdn11.bigcommerce.com/s-n0i50vy/images/stencil/1280x1280/products/109/361/kinfolkessentialissue_1024x1024__22507.1456436715.jpg?c=2&imbypass=on"
        },
        {
          "image_source": "https://cdn11.bigcommerce.com/s-n0i50vy/images/stencil/500x659/products/85/282/livingwithplants_grande__26452.1456436666.jpg?c=2&imbypass=on"
        },
        {
          "image_source": "https://cdn11.bigcommerce.com/s-n0i50vy/images/stencil/1280x1280/products/109/361/kinfolkessentialissue_1024x1024__22507.1456436715.jpg?c=2&imbypass=on"
        }
      ]
    },
    "widget_template": {
      "current_version_uuid": "c863f77b-e5b4-4462-a9ed-2aff9005140e",
      "date_created": "2020-12-21T19:49:29.110Z",
      "date_modified": "2020-12-21T19:49:29.110Z",
      "icon_name": "default",
      "kind": "custom",
      "name": "Header Images",
      "schema": [],
      "storefront_api_query": "",
      "template": "{{#each images}}{{/each}}",
      "uuid": "f8459145-da8f-4d98-93e4-83aa47da61c6",
      "channel_id": 1,
      "client_rerender": false,
      "template_engine": "handlebars_v3"
    },
    "storefront_api_query_params": {}
  },
  "meta": {}
}

Updates a Widget.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Content	modify	`store_v2_content`
Content	read-only	`store_v2_content_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

uuidstringRequiredformat: "uuid"

The identifier for a specific widget.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects an object.

channel_idintegerOptional

descriptionstringOptional

The user-friendly description.

namestringOptional

The user-friendly name.

upgradebooleanOptional

Upgrade the Widget to latest version of the WidgetTemplate.

widget_configurationobjectOptional

The JSON data that populates the template.

widget_template_uuidstringOptional

The widget template UUID.

Response

The requested widget.

dataobjectOptional

metaobjectOptional

Response metadata.

Errors

404

Not Found Error

422

Unprocessable Entity Error