For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Updates a *Page*. The request payload limit is 1MB.
**Read Only Fields**
* id
> #### 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](/developer/api-reference/rest/admin/content/pages/update-pages) endpoint. To update a single page, use Pages V3ʼs [Update a page](/developer/api-reference/rest/admin/content/pages/update-page) endpoint.
> * Updating the channel ID for a page is not supported.
Updates a Page. The request payload limit is 1MB.
Read Only Fields
id
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](/developer/docs/overview/api-fundamentals/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-fundamentals/api-accounts#x-auth-token-header-example-requests).
For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).
For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
Path parameters
idintegerRequired
ID of the page.
store_hashstringRequired
Permanent ID of the BigCommerce store.
Headers
AcceptstringRequiredDefaults to application/json
The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.
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
bodystring
HTML or variable that populates this page’s <body> element, in default/desktop view. Required in POST if page type is raw.
channel_iddouble
Channel ID.
contact_fieldsstring
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_typeenum
Allowed values:
emailstring
Where the page’s type is a contact form, the email address that receives messages sent using the form.
has_mobile_versionboolean
If true, this page has a mobile version. (For Blueprint themes only)
idintegerRead-only
ID of the page. Read-Only.
is_customers_onlyboolean
If true, this page is for customers only.
is_homepageboolean
If true, this page is the storefront’s home page.
is_visibleboolean
If true, this page appears in the storefront navigation menu.
layout_filestring
Layout template for this page. This field is writable only for stores with a Blueprint theme applied.
linkstring
If page type is link, this field is returned.
meta_descriptionstring
Description contained within this page’s <meta/> element. HTML to use for this page’s body when viewed in the mobile template.
meta_keywordsstring
Comma-separated list of SEO-relevant keywords to include in the page’s <meta/> element.
meta_titlestring
Text specified for this page’s <title> element. If empty, the value of the name property is used.
mobile_bodystring
HTML to use for this page’s body when viewed in the mobile template (deprecated - Blueprint only).
namestring
Page name, as displayed on the storefront.
parent_idinteger
ID of any parent Web page.
search_keywordsstring
Comma-separated list of keywords that shoppers can use to locate this page when searching the store.
sort_orderinteger
Order in which this page should display on the storefront. (Lower integers specify earlier display.)
typeenum
page: free-text page
link: link to another web address
contact_form: When the store’s contact form is used
Allowed values:
urlstring
Relative URL on the storefront for this page.
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_tokens, see our Guide to API Accounts.
