Create Pages

POST

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

POST

/stores/:store_hash/v3/content/pages

curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/content/pages \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "body": "<div>Hello World!</div>",
  "channel_id": 1,
  "is_homepage": false,
  "is_visible": false,
  "meta_description": "string",
  "meta_keywords": "string",
  "meta_title": "My Content page",
  "name": "Content Page",
  "parent_id": 0,
  "search_keywords": "string",
  "sort_order": 0,
  "type": "page",
  "url": "/my-content-page"
}'

{
  "data": {
    "channel_id": 1,
    "id": 1,
    "is_customers_only": false,
    "is_homepage": false,
    "is_visible": true,
    "meta_description": "\"\"",
    "meta_keywords": "\"\"",
    "meta_title": "string",
    "name": "About Our Company",
    "parent_id": 0,
    "search_keywords": "trousers,pockets,luxury",
    "sort_order": 0,
    "type": "page",
    "url": "/my-store-page"
  },
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

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

Web pages created via this endpoint are subject to the 4000 web page platform limit. Attempting to create pages over the limit will return an error. For more information on platform limits, see Platform Limits (Help Center).

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

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

includelist of enumsOptional

Include the requested property in the response. The body property returns the page’s markup, text, or raw content.

Allowed values:

Request

This endpoint expects an object or a list of objects.

Create single page using objectobjectRequired

Create multiple pages using arraylist of objectsRequired

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.

dataobjectOptional

metaobjectOptional

Data about the response, including pagination and collection totals.

Errors

422

Unprocessable Entity Error