The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.

Accept

The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body.

Content-Type

Full URL of where the resource is located.

addresses

Not returned in any responses, but accepts up to two fields allowing you to set the customer’s password. If a password is not supplied, it is generated automatically. For further information about using this object, please see the Customers resource documentation.

Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform.

We power ecommerce websites for successful retailers all over the world

Welcome to BigCommerce

Whether the blog post is published. If you want the post to be or remain published following the request, you must set the field explicitly to true, even if the blog post was already published prior to the request.

Description text for this blog post’s `<meta/>` element.

Keywords for this blog post’s `<meta/>` element.

Local path to a thumbnail uploaded to `/product_images/` using [WebDAV](https://support.bigcommerce.com/s/article/File-Access-WebDAV).

blogPost_Base

blogPost_Base_Post

blogPost_Base_Res

blogPost_Full

blogTags

+ `all` - Customers can access all categories
+ `specific`  - Customers can access a specific list of categories
+ `none` - Customers are prevented from viewing any of the categories in this group.

categoryAccessLevel

count_Response

Records whether the customer would like to receive marketing content from this store. READ-ONLY.This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.


The name of the company for which the customer works.

Date on which the customer registered from the storefront or was created in the control panel. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.

Date on which the customer updated their details in the storefront or was updated in the control panel. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.


Array of custom fields. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.

Unique numeric ID of this customer. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.

The customer’s IP address when they signed up.

The amount of credit the customer has. (Float, Float as String, Integer)

If applicable, the tax-exempt category of the shopperʼs customer account. You can apply a tax-exempt category to multiple customers. This code should match the exemption codes provided by the third-party integration.

customer_Full

A string that defines dates’ display formats, in the pattern: M jS Y

A string that defines the CSV export format for orders, customers, and products, in the pattern: M jS Y

A string that defines dates’ extended-display format, in the pattern: M jS Y @ g:i A.

dateFormat

formField

Reference of the redirect. Dynamic redirects will have the category or product number. Manual redirects will have the url that is being directed to.

The type of redirect. If it is a `manual` redirect then type will always be manual. Dynamic redirects will have the type of the page. Such as product or category.

forward

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

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, the email address that receives messages sent using the form.

If page type is `rss_feed` then this field is visible. Required in POST required for `rss page` type.

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

If true, this page is for customers only.

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

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

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

If page type is `link` this field is returned. Required in  POST to create a `link` page.

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

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

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

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

Page name, as displayed on the storefront.

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

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

`page`: free-text page
`link`: link to another web address
`rss_feed`: syndicated content from an RSS feed
`contact_form`: When the store’s contact form is used


Relative URL on the storefront for this page.

page_Base

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.

If page type is `rss_feed`, then this field is visible.

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

If page type is `link`, this field is returned.

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

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

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

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

page_Base_Res

page_Full

redirect

A boolean indicating whether this time zone observes daylight saving time.

A negative or positive number, identifying the offset from UTC/GMT, in seconds, during summer/daylight saving time.

A string identifying the time zone, in the format: `<Continent-name>/<City-name>`.

A negative or positive number, identifying the offset from UTC/GMT, in seconds, during winter/standard time.

timeZone

### 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](/docs/start/authentication/api-accounts). |

### Further reading

For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests).

For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes).

For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes).

X-Auth-Token

BigCommerce

Manage blog posts, blog tags, content pages, and redirects.

> #### Warning
> **Deprecations**
> * Redirects V2 are deprecated; use [Redirects V3](/docs/rest-management/redirects) instead. 
> * Pages V2 are deprecated; use [Pages V3](/docs/rest-content/pages) instead.

Content

page

limit

Returns all *Blog Posts*. Default sorting is by published_date, beginning with the most recent post.

is_published

published_date

Creates a *Blog Post*.

**Required Fields**
* `title`
* `body`

**Notes**

* When including `published_date` in a request, supply it as a flat date string (not an object) in valid <a href="http://tools.ietf.org/html/rfc2822#section-3.3" target="_blank">RFC 2822</a>. The following example request includes a `published_date` in RFC 2822 format.
* Blog posts default to draft status. To publish blog posts to the storefront, set the `is_published` property to `true`.
* If a custom URL is not provided, the post’s URL will be generated based on the value of `title`.

Multiple operations have taken place and the status for each operation can be viewed in the body of the response. Typically indicates that a partial failure has occurred, such as when a `POST` or `PUT` request is successful, but saving the URL has failed.

Updates a *Blog Post*.

**Notes**

* To include `published_date` in a request, provide a flat date string (not an object) in valid <a href="http://tools.ietf.org/html/rfc2822#section-3.3" target="_blank">RFC 2822</a>. The following example request includes a `published_date` in RFC 2822 format.

* Blog posts default to draft status. To publish blog posts to the storefront, set the `is_published` property to `true`.

Returns a list of *Pages*. Default sorting is by auto-generated ID from oldest to newest.

> #### Warning
> **Deprecated**
> * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
> * To get one or more pages, use Pages V3ʼs [Get pages](/docs/rest-content/pages#get-pages) endpoint. To get a single page, use Pages V3ʼs [Get a page](/docs/rest-content/pages#get-a-page) endpoint.


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

**Required Fields**
*   `type`
*   `name`
*   `link` (for a page of `type: link`)
*   `feed` (for a page of `type: rss_feed`)
*   `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](/docs/rest-content/pages#create-pages) endpoint. 

We're happy to answer questions or help you with returns. Please fill out the form below if you need assistance.

string

Contact Form

Deletes a *Page*.

> #### Warning
> **Deprecated**
> * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
> * To delete multiple pages, use Pages V3ʼs [Delete pages](/docs/rest-content/pages#delete-pages) endpoint. To delete a single page, use Pages V3ʼs [Delete a page](/docs/rest-content/pages#delete-a-page) endpoint. 


Returns a *Page*. 

> #### Warning
> **Deprecated**
> * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
> * To get a single page, use Pages V3ʼs [Get a page](/docs/rest-content/pages#get-a-page) endpoint.


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](/docs/rest-content/pages#update-pages) endpoint. To update a single page, use Pages V3ʼs [Update a page](/docs/rest-content/pages#update-a-page) endpoint.
> * Updating the channel ID for a page is not supported.

By default, it deletes all *Redirect URLs* in a store. 


> #### Warning
> **Deprecated**
> * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
> * To delete redirect URLs, use Redirects V3ʼs [Delete redirects](/docs/rest-management/redirects#delete-redirects) endpoint.

Returns a list all *Redirect URLs*. 

> #### Warning
> **Deprecated**
> * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
> * To get redirect URLs, use Redirects V3ʼs [Get redirects](/docs/rest-management/redirects#get-redirects) endpoint.

Creates a *Redirect URL*.

**Required Fields**
*   path
*   forward

**Read Only**
*   url


> #### Warning
> **Deprecated**
> * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
> * To upsert new redirect data, use Redirects V3ʼs [Upsert redirects](/docs/rest-management/redirects#upsert-redirects) endpoint.

Gets a count of *Redirect URLs* in a store.

> #### Warning
> **Deprecated**
> * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
> * To get a count of redirects, use the `meta` object data returned with the Redirects V3ʼs [Get redirects](/docs/rest-management/redirects#get-redirects) endpoint.

Deletes a *Redirect URL*.

> #### Warning
> **Deprecated** 
> * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
> * To delete a redirect URL, use Redirects V3ʼs [Delete redirects](/docs/rest-management/redirects#delete-redirects) endpoint.

Returns a single *Redirect URL*.

> #### Warning
> **Deprecated** 
> * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
> * To get a redirect URL, use Redirects V3ʼs [Get redirects](/docs/rest-management/redirects#get-redirects) endpoint.

Updates a *Redirect URL*.

**Required Fields**
*   path
*   forward

**Read Only Fields**
*   url


> #### Warning
> **Deprecated**
> * This API operation is deprecated. Avoid using this API operation if possible. It will be removed in a future version.
> * To update redirect data, use Redirects V3ʼs [Upsert redirects](/docs/rest-management/redirects#upsert-redirects) endpoint.

Redirects

Get All Redirects

Create a Redirect

Delete All Redirects

Get a Redirect

Update a Redirect

Delete a Redirect

Get a Count of Redirects