> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # UpdateBrand # Package: catalogV3 # Namespace: BrandService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/brands-v3/update-brand.md ## Permission Scopes: Brand write in v3 catalog: SCOPE.STORES.BRAND_WRITE ## Introduction Updates a brand. Each time the brand is updated, `revision` increments by 1. The current `revision` must be passed when updating the brand. This ensures you're working with the latest brand and prevents unintended overwrites. --- ## REST API ### Schema ``` Method: updateBrand Description: Updates a brand. Each time the brand is updated, `revision` increments by 1. The current `revision` must be passed when updating the brand. This ensures you're working with the latest brand and prevents unintended overwrites. URL: https://www.wixapis.com/stores/v3/brands/{brand.id} Method: PATCH # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: brand, brand.id, brand.revision Method parameters: param name: brand | type: Brand | description: A brand is a visible property of a product. Adding brands to your products can help improve site and product visibility on search engines. | required: true - name: id | type: string | description: Brand GUID. | required: true - name: revision | type: string | description: Revision number, which increments by 1 each time the brand is updated. To prevent conflicting changes, the current revision must be passed when updating the brand. Ignored when creating a brand. | required: true - name: name | type: string | description: Brand name. >**Note:** `name` must be unique. param name: fields | type: array | description: Fields to include in the response. Supported values: `ASSIGNED_PRODUCTS_COUNT` - enum: ASSIGNED_PRODUCTS_COUNT Return type: UpdateBrandResponse - name: brand | type: Brand | description: Updated brand. - name: id | type: string | description: Brand GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the brand is updated. To prevent conflicting changes, the current revision must be passed when updating the brand. Ignored when creating a brand. - name: createdDate | type: string | description: Date and time the brand was created. - name: updatedDate | type: string | description: Date and time the brand was updated. - name: name | type: string | description: Brand name. >**Note:** `name` must be unique. - name: assignedProductsCount | type: integer | description: Number of products this brand is assigned to. > **Note:** Returned only when you pass `"ASSIGNED_PRODUCTS_COUNT"` to the `fields` array in Brand API requests. ``` ### Examples ### Update a Brand Update a brand's name, by ID and revision. ```curl curl -X POST \ 'https://www.wixapis.com/stores/v3/brands/6a325aee-6c03-4934-a325-426b2a97ac52' \ -H 'Content-type: application/json' \ -H 'Authorization: ' \ -d '{ "brand": { "id": "6a325aee-6c03-4934-a325-426b2a97ac52", "revision": "1", "name": "Nike Air" } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.catalogV3.BrandService.updateBrand(_id, brand, options) Description: Updates a brand. Each time the brand is updated, `revision` increments by 1. The current `revision` must be passed when updating the brand. This ensures you're working with the latest brand and prevents unintended overwrites. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: brand, _id, brand.revision Method parameters: param name: _id | type: string | description: Brand GUID. | required: true param name: brand | type: UpdateBrand | description: A brand is a visible property of a product. Adding brands to your products can help improve site and product visibility on search engines. | required: true - name: revision | type: string | description: Revision number, which increments by 1 each time the brand is updated. To prevent conflicting changes, the current revision must be passed when updating the brand. Ignored when creating a brand. | required: true - name: name | type: string | description: Brand name. >**Note:** `name` must be unique. param name: options | type: UpdateBrandOptions none - name: fields | type: array | description: Fields to include in the response. Supported values: `ASSIGNED_PRODUCTS_COUNT` - enum: ASSIGNED_PRODUCTS_COUNT Return type: PROMISE - name: _id | type: string | description: Brand GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the brand is updated. To prevent conflicting changes, the current revision must be passed when updating the brand. Ignored when creating a brand. - name: _createdDate | type: Date | description: Date and time the brand was created. - name: _updatedDate | type: Date | description: Date and time the brand was updated. - name: name | type: string | description: Brand name. >**Note:** `name` must be unique. - name: assignedProductsCount | type: integer | description: Number of products this brand is assigned to. > **Note:** Returned only when you pass `"ASSIGNED_PRODUCTS_COUNT"` to the `fields` array in Brand API requests. ``` ### Examples ### Update a brand ```javascript import { brandsV3 } from "@wix/stores"; const brandId = "6a325aee-6c03-4934-a325-426b2a97ac52"; const brand = { id: "6a325aee-6c03-4934-a325-426b2a97ac52", revision: "1", name: "Nike Air" }; async function updateBrand() { const response = await brandsV3.updateBrand(brandId, brand); } /* Promise resolves to: * { * "_id": "6a325aee-6c03-4934-a325-426b2a97ac52", * "_createdDate": "2025-12-11T09:26:58.000Z", * "_updatedDate": "2025-12-11T09:27:01.000Z", * "revision": "2", * "name": "Nike Air" * } */ ``` ### updateBrand (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { brandsV3 } from '@wix/stores'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { brandsV3 }, // Include the auth strategy and host as relevant }); async function updateBrand(_id,brand,options) { const response = await myWixClient.brandsV3.updateBrand(_id,brand,options); }; ``` ---