Update Site

PUT

https://api.bigcommerce.com/stores/:store_hash/v3/sites/:site_id

PUT

/stores/:store_hash/v3/sites/:site_id

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

{
  "data": {
    "id": 23,
    "url": "https://example.com",
    "channel_id": 234,
    "created_at": "2018-01-04T04:15:50.000Z",
    "updated_at": "2018-01-04T04:15:50.000Z",
    "urls": [
      {
        "url": "https://example.com",
        "type": "primary",
        "created_at": "2020-11-03T19:26:12Z",
        "updated_at": "2021-08-31T21:46:50Z"
      },
      {
        "url": "https://store-29i23fcz6.mybigcommerce.com",
        "type": "canonical",
        "created_at": "2020-11-03T19:26:12Z",
        "updated_at": "2020-11-03T19:26:12Z"
      },
      {
        "url": "https://checkout.example.com",
        "type": "checkout",
        "created_at": "2020-11-03T19:26:12Z",
        "updated_at": "2021-08-31T21:46:50Z"
      }
    ],
    "is_checkout_url_customized": true
  },
  "meta": {}
}

Update a site with site ID {site_id}.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Channel Listings	modify	`store_channel_listings`
Channel Listings	read-only	`store_channel_listings_read_only`
Channel Settings	modify	`store_channel_settings`
Channel Settings	read-only	`store_channel_settings_read_only`
Sites & Routes	modify	`store_sites`
Sites & Routes	read-only	`store_sites_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

site_idintegerRequired

The ID of the site.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects an object.

urlstringOptional

The Fully Qualified URL (including host and scheme) where this site is hosted. All URLs generated for this site will be appended to this.

Response

The requested site.

dataobjectOptional

metaobjectOptional

Response metadata.

Errors

422

Unprocessable Entity Error