Create Page (deprecated)

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

Required Fields

type
name
link (for a page of type: link)
body (for a page of type: raw)

Read Only Fields

id

Content Type

The default value for content_type is text/html; however, if page_type is set to raw, content_type can be changed to text/javascript or application/json. Updating this field lets you place a JavaScript or a JSON file in the root directory.

Warning

Deprecated

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

To create one or more pages, use Pages V3ʼs Create pages endpoint.

Creates a *Page*. The request payload limit is 1MB. **Required Fields** * `type` * `name` * `link` (for a page of `type: link`) * `body` (for a page of `type: raw`) **Read Only Fields** * `id` ## Content Type The default value for `content_type` is `text/html`; however, if `page_type` is set to `raw`, `content_type` can be changed to `text/javascript` or `application/json`. Updating this field lets you place a JavaScript or a JSON file in the root directory. > #### Warning > **Deprecated** > * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version. > * To create one or more pages, use Pages V3ʼs [Create pages](/developer/api-reference/rest/admin/content/pages#create-pages) endpoint.

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.

Request

This endpoint expects an object.

namestringRequired

Page name, as displayed on the storefront.

bodystringRequired

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

typeenumRequired

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

Allowed values:

channel_iddoubleOptional

channel ID

meta_titlestringOptional

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

is_visiblebooleanOptional

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

parent_idintegerOptional

ID of any parent Web page.

sort_orderintegerOptional

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

meta_keywordsstringOptional

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

meta_descriptionstringOptional

Description contained within this page’s <meta/> element.

is_homepagebooleanOptional

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

is_customers_onlybooleanOptional

If true, this page is for customers only.

search_keywordsstringOptional

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

has_mobile_versionbooleanOptional

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

mobile_bodystringOptional

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

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.

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.

emailstringOptional

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

urlstringOptional

Relative URL on the storefront for this page.

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. Required in POST to create a link page.

content_typeenumOptional

Allowed values:

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.

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.

1	import requests
2
3	url = "https://api.bigcommerce.com/stores/store_hash/v2/pages"
4
5	payload = {
6	"name": "Contact Form",
7	"body": "<p>We're happy to answer questions or help you with returns.<br />Please fill out the form below if you need assistance.</p>",
8	"type": "page",
9	"channel_id": 1,
10	"meta_title": "string",
11	"is_visible": True,
12	"parent_id": 5,
13	"sort_order": 3,
14	"meta_keywords": "string",
15	"meta_description": "string",
16	"is_homepage": False,
17	"is_customers_only": False,
18	"search_keywords": "string",
19	"has_mobile_version": False,
20	"mobile_body": "0",
21	"contact_fields": "fullname,companyname,phone,orderno,rma",
22	"url": "/contact-us/"
23	}
24	headers = {
25	"X-Auth-Token": "<apiKey>",
26	"Content-Type": "application/json"
27	}
28
29	response = requests.post(url, json=payload, headers=headers)
30
31	print(response.json())

1	{
2	"body": "We're happy to answer questions or help you with returns.<br />Please fill out the form below if you need assistance.",
3	"channel_id": 11,
4	"has_mobile_version": false,
5	"id": 6,
6	"is_customers_only": true,
7	"is_homepage": false,
8	"is_visible": true,
9	"layout_file": "page.html",
10	"meta_description": "",
11	"meta_keywords": "",
12	"meta_title": "",
13	"mobile_body": "",
14	"name": "Contact Form",
15	"parent_id": 5,
16	"search_keywords": "",
17	"sort_order": 3,
18	"type": "page",
19	"url": "/contact-us/"
20	}

Content Type

Warning

Authentication

OAuth scopes

Authentication header

Further reading

Request

Response

Content Type

Warning

OAuth scopes

Authentication header

Further reading