PUT /catalog/brands/{brand_id}
Updates a brand.
To update a brand image, send a request with an image_url.
Servers
- https://api.bigcommerce.com/stores/{store_hash}/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
brand_id |
Integer | Yes |
The ID of the brand to which the resource belongs. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Accept |
String | Yes |
The MIME type of the response body. Default value: "application/json" |
Content-Type |
String | Yes |
The MIME type of the request body. Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | No |
Unique ID of the brand. |
meta_keywords[] |
Array | No |
An array of meta keywords to include in the HTML. |
name |
String | Yes |
The name of the brand. Must be unique. Required in POST. |
page_title |
String | No |
The title shown in the browser while viewing the brand. |
meta_description |
String | No |
A meta description to include. |
custom_url |
Object | No |
The custom URL for the brand on the storefront. |
custom_url.url |
String | No |
Brand URL on the storefront. Only letters, numbers, dots (.), dashes (-), underscores (_), and forward slashes (/) are allowed. Must be 1-1024 characters, consisting of segments divided by "/". Each segment must be 1-256 characters. |
custom_url.is_customized |
Boolean | No |
Returns |
search_keywords |
String | No |
A comma-separated list of keywords that can be used to locate this brand. |
image_url |
String | No |
Image URL used for this category on the storefront. Images can be uploaded via form file post to |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.