Create Widget

import requests
url = "https://api.bigcommerce.com/stores/store_hash/v3/content/widgets"
payload = {
    "name": "string",
    "widget_template_uuid": "string"
}
headers = {
    "X-Auth-Token": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "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": {}
}

Creates a Widget.

Note: There is a limit of 100,000 widgets per store and 150 widgets per page. For more information, see Store Limits.

Creates a **Widget**. **Note:** There is a limit of 100,000 widgets per store and 150 widgets per page. For more information, see [Store Limits](https://support.bigcommerce.com/s/article/Platform-Limits#storelimits).

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.

### 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](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Authentication

OAuth scopes

Authentication header

Further reading

Request

Response

Errors

OAuth scopes

Authentication header

Further reading