RESTAdminCatalogCategory TreesCategories

Update Categories

Updates existing categories.

To update a specific category in a tree, provide a category id.

Authentication

X-Auth-Tokenstring
### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Products | modify | `store_v2_products` | | Products | read-only | `store_v2_products_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).

Request

This endpoint expects a list of objects.
category_idintegerRequired

Unique ID of the Category. Increments sequentially.

namestringOptional1-50 characters

The name displayed for the category. Name is unique with respect to the categoryʼs siblings. Required in a POST.

tree_idintegerOptional

The ID of the category tree. To create a top-level category, specify the tree_id. Otherwise, you can specify the parent_id.

parent_idintegerOptional

The unique numeric ID of the category parent. To create a top-level category, specify the tree_id. Otherwise, you can specify the parent_id. Required in a POST if creating a child category.

descriptionstringOptional
The product description, which can include HTML formatting.
viewsintegerOptional
Number of views the category has on the storefront.
sort_orderintegerOptional-2147483648-2147483647
Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be.
page_titlestringOptional
Custom title for the category page. If not defined, the category name will be used as the meta title.
meta_keywordslist of stringsOptional

Custom meta keywords for the category page. If not defined, the storeʼs default keywords will be used. Must post as an array like: [“awesome”,“sauce”].

meta_descriptionstringOptional0-65535 characters

Custom meta description for the category page. If not defined, the storeʼs default meta description will be used.

layout_filestringOptional0-50 characters

A valid layout file. (Please refer to this article on creating category files.) This field is writable only for stores with a Blueprint theme applied.

image_urlstringOptional

Image URL used for this category on the storefront. Images can be uploaded via form file post to /categories/{categoryId}/image, or by providing a publicly accessible URL in this field. Must be either a full-qualified URL or an empty string.

is_visiblebooleanOptional

Flag to determine whether the product should be displayed to customers browsing the store. If true, the category will be displayed. If false, the category will be hidden from view.

search_keywordsstringOptional0-255 characters

A comma-separated list of keywords that can be used to locate the category when searching the store.

default_product_sortenumOptional
Determines how the products are sorted on category page load.
urlobjectOptional
If not provided in POST request, the URL is autogenerated from the category name.

Response

OK
metaobject

Errors

400
Bad Request Error
403
Forbidden Error
422
Unprocessable Entity Error