Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-18160240.4 KB
Brand

Update brand

📘 This API is part of the Seller Portal Catalog. This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact our Support Center.

Updates an existing brand.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
CatalogV2ManagementBrand Write

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

put/api/catalog-seller-portal/brands/{brandId}

Path parameters

brandIdstring required
Example:20

Brand unique identifier number.

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

idstring required

Brand unique identifier number.

namestring required

Brand name.

isActiveboolean required

The condition defines if the brand is active (true) or inactive (false).

Example request

{
  "id": "20",
  "name": "Zwilling",
  "isActive": true
}

Response

No Content