Pages V3

Overview

A page appears on a site that is associated with a channel.

Some pages, such as blog pages, contact forms, and plain-text or HTML pages, are web pages in the traditional sense. They contain markup (a body) and load at a relative page location on the site itself (the url). Other pages, such as link and feed pages, make external or non-visual content available from the menu of a parent page or by direct link.

Bulk operations

All endpoints without a pageId path parameter support bulk operations.

Page types

The following table describes the types of pages that the Pages API can manage:

Page Type	Description	Body
`page`	A user-defined plain-text page.	text
`contact_form`	A user-customizable page that contains a contact form.	HTML
`raw`	A user-defined page that contains HTML markup or other stringified code.	HTML, other code
`blog`	A page that contains blog posts. Use caution; `blog`-type pages can only be created in the store control panel, but you may be able to change the type of a blog page to something else with this API. Use the blog feature of the REST Content API to work with blog posts and tags.	empty string
`feed`	Makes RSS-syndicated content feeds available in the menu of other pages that contain markup.	—
`link`	A link to an external absolute URL. Displays in the menu of other pages that contain markup.	—

Get Pages

GET https://api.bigcommerce.com/stores/{store_hash}/v3/content/pages

Request

Returns one or more content pages. This endpoint supports bulk operations.

Authentication

X-Auth-Token in header
required

Parameters

store_hash in path - string
channel_id in query - integer
Return only pages associated with the specified channel.
id:in in query - array
A comma-separated string of page IDs to fetch. Supports bulk operations. If none of the page IDs passed exist, the query will return an empty data array.
name in query - string
Name of the page.
name:like in query - string
Return only pages whose name or body contain the supplied string.
limit in query - integer
The number of results to return per request. See meta.pagination.per_page in the response body.
page in query - integer
The ordered grouping of results to return. See meta.pagination.current_page in the response body.
include in query - array
Include the requested property in the response. The body property returns the page’s markup, text, or raw content.

example

Response

Body

object | application/json

Response payload for the BigCommerce API.

dataarray[]
metaobject
Data about the response, including pagination and collection totals.

example

Create Pages

POST https://api.bigcommerce.com/stores/{store_hash}/v3/content/pages

Request

Creates one or more content pages. This endpoint supports bulk operations.

Authentication

X-Auth-Token in header
required

Parameters

store_hash in path - string
include in query - array
Include the requested property in the response. The body property returns the page’s markup, text, or raw content.
Content-Type in header with default of application/json - string
required

Body

application/json

One of:

Create single page using object

Create multiple pages using array

Response

Created.

Response.data will inherit the data type of the request. A single entry passed as an object will return an object for the data property. Any number of entries passed in an array will return an array for the data property.

Properties associated with a page type that are not required to create an entry will be created with default values.

When you make bulk requests, an invalid input in any one entry will return 422. The entries that are valid will still be created.

Body

object | application/json

data
Any of:
- idinteger
  read-only
- channel_idinteger
  read-only
  Default: 1
- namestring
  required
  The name of the page. Must be unique.
  >= 1 characters<= 100 characters
  Example: About Our Company
- is_visibleboolean
  A boolean value that controls whether the page is available to users or visible in any navigation menus.
  Example: true
  Default: true
- parent_idinteger
  ID of the parent page, if any.
  Example: 0
  Default: 0
- sort_orderinteger
  Determines the order in which the page is displayed in the parent page’s menu. Pages with lower integers display earlier.
  Example: 0
- typestring
  required
  Determines the type of page. See Pages V3 page types for more about the differences.
  Allowed: page | raw | contact_form | feed | link | blog
  Example: page
- is_homepageboolean
  Determines whether this page loads at the siteʼs root route. For example, at https://example.com/.
  Default: false
- is_customers_onlyboolean
  When true, this page is not visible to merchant users who are signed in to the store control panel.
  Default: false
- urlstring
  Relative URL on the storefront for this page.
  Example: /my-store-page
- meta_titlestring or null
- meta_keywordsstring or null
  Comma-separated list of SEO-relevant keywords to include in the element of this page.
  Default: ""
- meta_descriptionstring or null
  Description contained within the element of this page.
  Default: ""
- search_keywordsstring or null
  Comma-separated list of keywords that shoppers can use to locate this page when searching the store.
  Example: trousers,pockets,luxury
  Default: ""
metaobject
Data about the response, including pagination and collection totals.

example

Update Pages

PUT https://api.bigcommerce.com/stores/{store_hash}/v3/content/pages

Request

Updates one or more content pages. This endpoint supports bulk operations.

Authentication

X-Auth-Token in header
required

Parameters

store_hash in path - string
include in query - array
Include the requested property in the response. The body property returns the page’s markup, text, or raw content.
Content-Type in header with default of application/json - string
required

Body

application/json

One of:

idinteger
The ID of the target page.

namestring
The name of the page. Must be unique.
>= 1 characters<= 100 characters
Example: My Store Page
is_visibleboolean
Boolean value that specifies the visibility of the page in the storefront’s navigation menu.

Indicates whether the page is available to users and visible in any menus.
parent_idinteger
ID of any parent Web page.
Example: 0
Default: 0
sort_orderinteger
Specifies the order in which the page is displayed on the storefront. (Lower integers specify earlier display.)
Example: 0
Default: 0
typestring
Specifies the type of page. See Pages V3 page types for more about the differences.
Allowed: page | raw | contact_form | feed | link | blog
Example: page
is_homepageboolean
Boolean value that specifies whether this page is the storefront’s home page.
is_customers_onlyboolean
Boolean value. If this value is set to true, this page will not be visible when the user is logged in to the store control panel.
emailstring
Applicable when the page type is contact_form: contact email address that receives messages sent via the form. Must be unique.
<= 255 characters
meta_titlestring or null
bodystring or null
HTML or variable that populates the element of this page, in default/desktop view. Required in a POST request if the page type is raw.
Example: <div>Hello World!</div>
feedstring
The URL of the RSS feed. Required in a POST request if the page type is feed.
linkstring
Required in a POST request to create a link if the page type is link.

contact_fieldsstring

Applicable when the page type is contact_form: comma-separated list of keywords representing the fields enabled in the control panel for storefront display. Possible fields include:

Field	Description
`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

Example: fullname,companyname,phone,orderno,rma

meta_keywordsstring or null
Comma-separated list of SEO-relevant keywords to include in the element of this page.
Default:
meta_descriptionstring or null
Description contained within the element of this page.
search_keywordsstring or null
Comma-separated list of keywords that shoppers can use to locate this page when searching the store.
Example: trousers,pockets,luxury
urlstring
Relative URL on the storefront for this page.
Example: /my-store-page
channel_idinteger
The ID of the channel where this page should be shown.
Example: 12
Default: 1

One of:

idinteger
The ID of the target page.

namestring
The name of the page. Must be unique.
>= 1 characters<= 100 characters
Example: My Store Page
is_visibleboolean
Boolean value that specifies the visibility of the page in the storefront’s navigation menu.

Indicates whether the page is available to users and visible in any menus.
parent_idinteger
ID of any parent Web page.
Example: 0
Default: 0
sort_orderinteger
Specifies the order in which the page is displayed on the storefront. (Lower integers specify earlier display.)
Example: 0
Default: 0
typestring
Specifies the type of page. See Pages V3 page types for more about the differences.
Allowed: page | raw | contact_form | feed | link | blog
Example: page
is_homepageboolean
Boolean value that specifies whether this page is the storefront’s home page.
is_customers_onlyboolean
Boolean value. If this value is set to true, this page will not be visible when the user is logged in to the store control panel.
emailstring
Applicable when the page type is contact_form: contact email address that receives messages sent via the form. Must be unique.
<= 255 characters
meta_titlestring or null
bodystring or null
HTML or variable that populates the element of this page, in default/desktop view. Required in a POST request if the page type is raw.
Example: <div>Hello World!</div>
feedstring
The URL of the RSS feed. Required in a POST request if the page type is feed.
linkstring
Required in a POST request to create a link if the page type is link.

contact_fieldsstring

Applicable when the page type is contact_form: comma-separated list of keywords representing the fields enabled in the control panel for storefront display. Possible fields include:

Field	Description
`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

Example: fullname,companyname,phone,orderno,rma

meta_keywordsstring or null
Comma-separated list of SEO-relevant keywords to include in the element of this page.
Default:
meta_descriptionstring or null
Description contained within the element of this page.
search_keywordsstring or null
Comma-separated list of keywords that shoppers can use to locate this page when searching the store.
Example: trousers,pockets,luxury
urlstring
Relative URL on the storefront for this page.
Example: /my-store-page
channel_idinteger
The ID of the channel where this page should be shown.
Example: 12
Default: 1

example

Response

Updated.

Body

object | application/json

Response payload for the BigCommerce API.

dataarray[]
metaobject
Data about the response, including pagination and collection totals.

update meta descriptions for two pages

Delete Pages

DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/content/pages

Request

Deletes one or more content pages. This endpoint supports bulk operations.

Warning

Pay attention to query parameters If you attempt to delete multiple pages by passing more than one page ID to id:in and one or more of them does not exist, you will receive a 404 response. However, the pages corresponding to the page IDs that do exist will still be deleted.

Authentication

X-Auth-Token in header
required

Parameters

store_hash in path - string
id:in in query - array
required
Request deletion of multiple pages by passing a comma-separated string of corresponding page IDs. Supports bulk operations.

example

Response

No content. A 204 response with no payload indicates successful deletion of all specified pages.

Get a Page

GET https://api.bigcommerce.com/stores/{store_hash}/v3/content/pages/{pageId}

Request

Returns one content page.

Warning

Pay attention to query parameters This endpoint recognizes the same query parameters as Get Multiple Pages. If the requested page does not meet the query parameters you specify, you will receive a 404 response even if the requested pageId does exist.

Authentication

X-Auth-Token in header
required

Parameters

store_hash in path - string
include in query - array
Include the requested property in the response. The body property returns the page’s markup, text, or raw content.

example

Response

Body

object | application/json

Response payload for a single content page.

dataobject
Any of:
- idinteger
  read-only
- channel_idinteger
  read-only
  Default: 1
- namestring
  required
  The name of the page. Must be unique.
  >= 1 characters<= 100 characters
  Example: About Our Company
- is_visibleboolean
  A boolean value that controls whether the page is available to users or visible in any navigation menus.
  Example: true
  Default: true
- parent_idinteger
  ID of the parent page, if any.
  Example: 0
  Default: 0
- sort_orderinteger
  Determines the order in which the page is displayed in the parent page’s menu. Pages with lower integers display earlier.
  Example: 0
- typestring
  required
  Determines the type of page. See Pages V3 page types for more about the differences.
  Allowed: page | raw | contact_form | feed | link | blog
  Example: page
- is_homepageboolean
  Determines whether this page loads at the siteʼs root route. For example, at https://example.com/.
  Default: false
- is_customers_onlyboolean
  When true, this page is not visible to merchant users who are signed in to the store control panel.
  Default: false
- urlstring
  Relative URL on the storefront for this page.
  Example: /my-store-page
- meta_titlestring or null
- meta_keywordsstring or null
  Comma-separated list of SEO-relevant keywords to include in the element of this page.
  Default: ""
- meta_descriptionstring or null
  Description contained within the element of this page.
  Default: ""
- search_keywordsstring or null
  Comma-separated list of keywords that shoppers can use to locate this page when searching the store.
  Example: trousers,pockets,luxury
  Default: ""
metaobject
Data about the response, including pagination and collection totals.

several data types

Update a Page

PUT https://api.bigcommerce.com/stores/{store_hash}/v3/content/pages/{pageId}

Request

Updates one content page.

Authentication

X-Auth-Token in header
required

Parameters

store_hash in path - string
Content-Type in header with default of application/json - string
required
include in query - array
Include the requested property in the response. The body property returns the page’s markup, text, or raw content.

Body

object | application/json

Properties of the page modification request body.

namestring
The name of the page. Must be unique.
>= 1 characters<= 100 characters
Example: My Store Page
is_visibleboolean
Boolean value that specifies the visibility of the page in the storefront’s navigation menu.

Indicates whether the page is available to users and visible in any menus.
parent_idinteger
ID of any parent Web page.
Example: 0
Default: 0
sort_orderinteger
Specifies the order in which the page is displayed on the storefront. (Lower integers specify earlier display.)
Example: 0
Default: 0
typestring
Specifies the type of page. See Pages V3 page types for more about the differences.
Allowed: page | raw | contact_form | feed | link | blog
Example: page
is_homepageboolean
Boolean value that specifies whether this page is the storefront’s home page.
is_customers_onlyboolean
Boolean value. If this value is set to true, this page will not be visible when the user is logged in to the store control panel.
emailstring
Applicable when the page type is contact_form: contact email address that receives messages sent via the form. Must be unique.
<= 255 characters
meta_titlestring or null
bodystring or null
HTML or variable that populates the element of this page, in default/desktop view. Required in a POST request if the page type is raw.
Example: <div>Hello World!</div>
feedstring
The URL of the RSS feed. Required in a POST request if the page type is feed.
linkstring
Required in a POST request to create a link if the page type is link.

contact_fieldsstring

Applicable when the page type is contact_form: comma-separated list of keywords representing the fields enabled in the control panel for storefront display. Possible fields include:

Field	Description
`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

Example: fullname,companyname,phone,orderno,rma

meta_keywordsstring or null
Comma-separated list of SEO-relevant keywords to include in the element of this page.
Default:
meta_descriptionstring or null
Description contained within the element of this page.
search_keywordsstring or null
Comma-separated list of keywords that shoppers can use to locate this page when searching the store.
Example: trousers,pockets,luxury
urlstring
Relative URL on the storefront for this page.
Example: /my-store-page
channel_idinteger
The ID of the channel where this page should be shown.
Example: 12
Default: 1

example

Response

Body

object | application/json

Response payload for a single content page.

dataobject
Any of:
- idinteger
  read-only
- channel_idinteger
  read-only
  Default: 1
- namestring
  required
  The name of the page. Must be unique.
  >= 1 characters<= 100 characters
  Example: About Our Company
- is_visibleboolean
  A boolean value that controls whether the page is available to users or visible in any navigation menus.
  Example: true
  Default: true
- parent_idinteger
  ID of the parent page, if any.
  Example: 0
  Default: 0
- sort_orderinteger
  Determines the order in which the page is displayed in the parent page’s menu. Pages with lower integers display earlier.
  Example: 0
- typestring
  required
  Determines the type of page. See Pages V3 page types for more about the differences.
  Allowed: page | raw | contact_form | feed | link | blog
  Example: page
- is_homepageboolean
  Determines whether this page loads at the siteʼs root route. For example, at https://example.com/.
  Default: false
- is_customers_onlyboolean
  When true, this page is not visible to merchant users who are signed in to the store control panel.
  Default: false
- urlstring
  Relative URL on the storefront for this page.
  Example: /my-store-page
- meta_titlestring or null
- meta_keywordsstring or null
  Comma-separated list of SEO-relevant keywords to include in the element of this page.
  Default: ""
- meta_descriptionstring or null
  Description contained within the element of this page.
  Default: ""
- search_keywordsstring or null
  Comma-separated list of keywords that shoppers can use to locate this page when searching the store.
  Example: trousers,pockets,luxury
  Default: ""
metaobject
Data about the response, including pagination and collection totals.

example

Delete a Page

DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/content/pages/{pageId}

Request

Deletes one content page.

Warning

Query parameters not recognized This endpoint does not recognize query parameters.

Authentication

X-Auth-Token in header
required

Parameters

store_hash in path - string
Accept in header with default of application/json - string
required
pageId in path - string
required
The ID of the page to be operated on.

example

Response

No content. A 204 response with no payload indicates successful deletion of all specified pages.

Did you find what you were looking for?

Delete Email Template Override Get Pages

Pages V3

Overview

Bulk operations

Page types

Get Pages

Request

Authentication

Parameters

example

Response

Body

dataarray[]

metaobject

example

Create Pages

Request

Authentication

Parameters

Body

Create single page using object

Create multiple pages using array

Response

Body

data

idintegerread-only

channel_idintegerread-only

namestringrequired

is_visibleboolean

parent_idinteger

sort_orderinteger

typestringrequired

is_homepageboolean

is_customers_onlyboolean

urlstring

meta_titlestring or null

meta_keywordsstring or null

meta_descriptionstring or null

search_keywordsstring or null

metaobject

example

Update Pages

Request

Authentication

Parameters

Body

idinteger

namestring

is_visibleboolean

parent_idinteger

sort_orderinteger

typestring

is_homepageboolean

is_customers_onlyboolean

emailstring

meta_titlestring or null

bodystring or null

feedstring

linkstring

contact_fieldsstring

meta_keywordsstring or null

meta_descriptionstring or null

search_keywordsstring or null

urlstring

channel_idinteger

idinteger

namestring

is_visibleboolean

parent_idinteger

sort_orderinteger

typestring

is_homepageboolean

is_customers_onlyboolean

emailstring

meta_titlestring or null

bodystring or null

feedstring

linkstring

contact_fieldsstring

meta_keywordsstring or null

meta_descriptionstring or null

idinteger
read-only

channel_idinteger
read-only

namestring
required

typestring
required

idinteger
read-only

channel_idinteger
read-only

namestring
required

typestring
required

idinteger
read-only

channel_idinteger
read-only