Update Page (deprecated)

Deprecated

PUT

https://api.bigcommerce.com/stores/:store_hash/v2/pages/:id

PUT

/stores/:store_hash/v2/pages/:id

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

200Response

{
  "body": "<em>To edit this page simply login to the control panel, click the <strong style='font-weight: 400'>Website Content</strong> tab and choose the </em> <strong style='font-weight: 400'><em>View Web Pages option. Click Edit next to the Shipping & Returns page and you can change this text. A sample returns policy is shown below which you can edit as needed.</em><em style='font-style: normal'><br/><br/></em></strong><em style='font-style: normal'><strong>Returns Policy</strong></em><strong style='font-weight: 400'></em></em><em style='font-style: normal'><br/><br/></em>You may return most new, unopened items within 30 days of delivery for a full refund. We'll also pay the return shipping costs if the return is a result of our error (you received an incorrect or defective item, etc.).<br/><br/>You should expect to receive your refund within four weeks of giving your package to the return shipper, however, in many cases you will receive a refund more quickly. This time period includes the transit time for us to receive your return from the shipper (5 to 10 business days), the time it takes us to process your return once we receive it (3 to 5 business days), and the time it takes your bank to process our refund request (5 to 10 business days).<br/><br/>If you need to return an item, please <a href='/contact-us/'>Contact Us</a> with your order number and details about the product you would like to return. We will respond quickly with instructions for how to return items from your order.<br/><br/></strong><strong>Shipping</em></em></em></strong><strong style='font-weight: 400'><em style='font-style: normal'><br/><br/></em>We can ship to virtually any address in the world. Note that there are restrictions on some products, and some products cannot be shipped to international destinations.<br/><br/>When you place an order, we will estimate shipping and delivery dates for you based on the availability of your items and the shipping options you choose. Depending on the shipping provider you choose, shipping date estimates may appear on the shipping quotes page.<br/><br/>Please also note that the shipping rates for many items we sell are weight-based. The weight of any such item can be found on its detail page. To reflect the policies of the shipping companies we use, all weights will be rounded up to the next full pound.<br/>",
  "channel_id": 11,
  "has_mobile_version": false,
  "id": 2,
  "is_customers_only": false,
  "is_homepage": false,
  "is_visible": true,
  "layout_file": "page.html",
  "link": "",
  "meta_description": "",
  "meta_keywords": "",
  "meta_title": "",
  "mobile_body": "",
  "name": "Shipping & Returns",
  "parent_id": 0,
  "search_keywords": "",
  "sort_order": 2,
  "type": "page",
  "url": "/shipping-returns/"
}

Updates a Page. The request payload limit is 1MB.

Read Only Fields

Warning

Deprecated

This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.

To update multiple pages, use Pages V3ʼs Update pages endpoint. To update a single page, use Pages V3ʼs Update a page endpoint.

Updating the channel ID for a page is not supported.

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

idintegerRequired

ID of the page.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects an object.

bodystringOptional

HTML or variable that populates this page’s <body> element, in default/desktop view. Required in POST if page type is raw.

channel_iddoubleOptional

Channel ID.

contact_fieldsstringOptional

Where the page’s type is a contact form - object whose members are the fields enabled (in the control panel) for storefront display. Possible members are:fullname - full name of the customer submitting the form; phone - customer’s phone number, as submitted on the form; companyname- customer’s submitted company name; orderno- customer’s submitted order number; rma - customer’s submitted RMA (Return Merchandise Authorization) number.

content_typeenumOptional

Allowed values:

emailstringOptional

Where the page’s type is a contact form, the email address that receives messages sent using the form.

has_mobile_versionbooleanOptional

If true, this page has a mobile version. (For Blueprint themes only)

is_customers_onlybooleanOptional

If true, this page is for customers only.

is_homepagebooleanOptional

If true, this page is the storefront’s home page.

is_visiblebooleanOptional

If true, this page appears in the storefront navigation menu.

layout_filestringOptional

Layout template for this page. This field is writable only for stores with a Blueprint theme applied.

linkstringOptional

If page type is link, this field is returned.

meta_descriptionstringOptional

Description contained within this page’s <meta/> element. HTML to use for this page’s body when viewed in the mobile template.

meta_keywordsstringOptional

Comma-separated list of SEO-relevant keywords to include in the page’s <meta/> element.

meta_titlestringOptional

Text specified for this page’s <title> element. If empty, the value of the name property is used.

mobile_bodystringOptional

HTML to use for this page’s body when viewed in the mobile template (deprecated - Blueprint only).

namestringOptional

Page name, as displayed on the storefront.

parent_idintegerOptional

ID of any parent Web page.

search_keywordsstringOptional

Comma-separated list of keywords that shoppers can use to locate this page when searching the store.

sort_orderintegerOptional

Order in which this page should display on the storefront. (Lower integers specify earlier display.)

typeenumOptional

page: free-text page link: link to another web address contact_form: When the store’s contact form is used

Allowed values:

urlstringOptional

Relative URL on the storefront for this page.

Response

bodystringOptional

HTML or variable that populates this page’s <body> element, in default/desktop view. Required in POST if page type is raw.

channel_iddoubleOptional

Channel ID.

contact_fieldsstringOptional

content_typeenumOptional

Allowed values:

emailstringOptional

Where the page’s type is a contact form, the email address that receives messages sent using the form.

has_mobile_versionbooleanOptional

If true, this page has a mobile version. (For Blueprint themes only)

idintegerOptionalRead-only

ID of the page. Read-Only.

is_customers_onlybooleanOptional

If true, this page is for customers only.

is_homepagebooleanOptional

If true, this page is the storefront’s home page.

is_visiblebooleanOptional

If true, this page appears in the storefront navigation menu.

layout_filestringOptional

Layout template for this page. This field is writable only for stores with a Blueprint theme applied.

linkstringOptional

If page type is link, this field is returned.

meta_descriptionstringOptional

Description contained within this page’s <meta/> element. HTML to use for this page’s body when viewed in the mobile template.

meta_keywordsstringOptional

Comma-separated list of SEO-relevant keywords to include in the page’s <meta/> element.

meta_titlestringOptional

Text specified for this page’s <title> element. If empty, the value of the name property is used.

mobile_bodystringOptional

HTML to use for this page’s body when viewed in the mobile template (deprecated - Blueprint only).

namestringOptional

Page name, as displayed on the storefront.

parent_idintegerOptional

ID of any parent Web page.

search_keywordsstringOptional

Comma-separated list of keywords that shoppers can use to locate this page when searching the store.

sort_orderintegerOptional

Order in which this page should display on the storefront. (Lower integers specify earlier display.)

typeenumOptional

page: free-text page link: link to another web address contact_form: When the store’s contact form is used

Allowed values:

urlstringOptional

Relative URL on the storefront for this page.

Update Page (deprecated)

Warning

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Headers

Request

Response