Update Brand | BigCommerce Developer Center

Updates a brand.

To update a brand image, send a request with an image_url.

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.

### 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-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Path parameters

brand_idstringRequired

Request

Common Brand properties.

namestringRequired1-255 characters

The name of the brand. Must be unique. Required in POST.

page_titlestringOptional0-255 characters

The title shown in the browser while viewing the brand.

meta_keywordslist of stringsOptional

An array of meta keywords to include in the HTML.

meta_descriptionstringOptional0-65535 characters

A meta description to include.

search_keywordsstringOptional0-65535 characters

A comma-separated list of keywords that can be used to locate this brand.

image_urlstringOptional

Image URL used for this category on the storefront. Images can be uploaded via form file post to /brands/{brandId}/image, or by providing a publicly accessible URL in this field.

custom_urlobjectOptional

The custom URL for the brand on the storefront.

Response

dataobject

Common Brand properties.

metaobject

Response metadata.

Errors

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

1	import requests
2
3	url = "https://api.bigcommerce.com/stores/store_hash/v3/catalog/brands/brand_id"
4
5	payload = { "name": "Common Good" }
6	headers = {
7	"X-Auth-Token": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.put(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"data": [
3	{
4	"id": 1,
5	"name": "Common Good",
6	"page_title": "Common Good",
7	"meta_keywords": [
8	"modern",
9	"clean",
10	"contemporary"
11	],
12	"meta_description": "Common Good is a modern brand.",
13	"search_keywords": "kitchen, laundry, cart, storage",
14	"image_url": "https://cdn8.bigcommerce.com/s-12345/product_images/k/your-image-name.png",
15	"custom_url": {
16	"url": "string",
17	"is_customized": true
18	}
19	}
20	],
21	"meta": {
22	"total": 3,
23	"success": 3,
24	"failed": 0
25	},
26	"errors": {
27	"status": 422,
28	"title": "Bulk operation has failed",
29	"type": "/developer/api-reference/rest/overview#rest-http-status-codes",
30	"errors": {}
31	}
32	}