v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-29208421.4 MB

Update category

Updates a previously existing category.

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:

Product	Category	Resource
Catalog	Content	Categories Management

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/pvt/category/{categoryId}

Path parameters

categoryIdinteger required

Example:9289

Category's unique numerical identifier.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

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

Request body

Namestring required

Category name.

Keywordsstring required

Substitute words for the category.

Titlestring required

Text used in title tag for category page.

Descriptionstring required

Text used in meta description tag for category page.

AdWordsRemarketingCodestring nullable required

This is a legacy field. Do not take this information into consideration.

LomadeeCampaignCodestring nullable required

This is a legacy field. Do not take this information into consideration.

FatherCategoryIdinteger nullable required

ID of the parent category, apply in case of category and subcategory.

GlobalCategoryIdinteger required

Google global category ID.

ShowInStoreFrontboolean required

If true, the category is shown in the top and side menu.

IsActiveboolean required

If true, the category page becomes available in store.

ActiveStoreFrontLinkboolean required

If true, the category link becomes active in store.

ShowBrandFilterboolean required

If true, the category page displays a brand filter.

Scoreinteger required

Score for search sorting order.

StockKeepingUnitSelectionModestring required

Defines how the SKU will be exhibited.

Example request

{
  "Name": "Home Appliances",
  "Keywords": "Kitchen, Laundry, Appliances",
  "Title": "Home Appliances",
  "Description": "Discover our range of home appliances. Find smart vacuums, kitchen and laundry appliances to suit your needs. Order online now.",
  "AdWordsRemarketingCode": "Sale",
  "LomadeeCampaignCode": "Sale",
  "FatherCategoryId": 2,
  "GlobalCategoryId": 222,
  "ShowInStoreFront": true,
  "IsActive": true,
  "ActiveStoreFrontLink": true,
  "ShowBrandFilter": true,
  "Score": 3,
  "StockKeepingUnitSelectionMode": "SPECIFICATION"
}

Response

Idinteger required

Category ID.

Namestring required

Category name.

FatherCategoryIdinteger nullable required

ID of the father category, apply in case of category and subcategory.

Titlestring required

Category page title.

Descriptionstring required

Describes details about the category.

Keywordsstring required

Substitutes words for the category.

IsActiveboolean required

Shows if the category is active (true) or not (false).

LomadeeCampaignCodestring required

This is a legacy field. Do not take this information into consideration.

AdWordsRemarketingCodestring required

This is a legacy field. Do not take this information into consideration.

ShowInStoreFrontboolean required

Defines if the category is shown on side and upper menu (true) or not (false).

ShowBrandFilterboolean required

Defines if the category has brand filter (true) or not (false).

ActiveStoreFrontLinkboolean required

Defines if the category has an active link on the website (true) or not (false).

GlobalCategoryIdinteger required

Google global category ID.

StockKeepingUnitSelectionModestring required

Defines how the SKU will be exhibited.

Scoreinteger nullable required

Score for search ordination.

LinkIdstring required

Category text link ID. This field value is automatically generated when you create or update a category, and it corresponds to the category name. Once the category linkId is generated, it cannot be modified directly, but you can change it by updating the category with a new name.

HasChildrenboolean required

Defines if the category has child categories (true) or not (false).

TreePathstring[] nullable required

Category tree path, which corresponds to the category name as it is.

Unless your request includes the query param includeTreePath set as true, this field will return null.

TreePathIdsinteger[] nullable required

All of the category tree path IDs. Every nested category would correspond to a path ID.

Unless your request includes the query param includeTreePath set as true, this field will return null.

TreePathLinkIdsstring[] nullable required

List of category tree path link IDs. A link ID is the identifier that forms the last part of the category URL, normalizing special characters.

Unless your request includes the query param includeTreePath set as true, this field will return null.