Sign in

v50

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

Update specification field

Updates a specification field in a category.

⚠️ This is a legacy endpoint. We recommend using Update specification instead.

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
CatalogCommercialSKU 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_system/pvt/specification/field

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

Specification field ID.

CategoryIdinteger nullable required

Category ID.

FieldIdinteger nullable required

Specification field ID.

IsActiveboolean required

Enables(true) or disables (false) the specification field.

IsRequiredboolean required

Makes the specification field mandatory (true) or optional (false).

FieldTypeIdinteger required

Specification field type ID.

FieldValueIdinteger nullable

Specification field value ID.

Descriptionstring nullable required

Specification field description.

IsStockKeepingUnitboolean required

If true, it will be added as a SKU specification field. If false, it will be added as a product specification field.

IsFilterboolean required

Store Framework - Deprecated. Legacy CMS Portal - To allow the specification to be used as a facet (filter) on the search navigation bar.

IsOnProductDetailsboolean required

Store Framework - Deprecated. Legacy CMS Portal - If the specification is visible on the product page.

Positioninteger required

Specification field position.

IsWizardboolean required

Deprecated field.

IsTopMenuLinkActiveboolean required

Store Framework - Deprecated. Legacy CMS Portal - To make the specification visible in the store's upper menu.

IsSideMenuLinkActiveboolean required

Store Framework - Deprecated. Legacy CMS Portal - To make the specification field clickable in the search navigation bar.

DefaultValuestring nullable required

Specification field default value.

FieldGroupIdinteger required

Specification field group ID.

FieldGroupNamestring required

Specification field group name.

Example request

{
  "Name": "Material",
  "CategoryId": 4,
  "FieldId": 89,
  "IsActive": true,
  "IsRequired": true,
  "FieldTypeId": 1,
  "FieldValueId": 143,
  "Description": "Composition of the product.",
  "IsFilter": true,
  "IsOnProductDetails": true,
  "Position": 1,
  "DefaultValue": "Cotton",
  "FieldGroupId": 20,
  "FieldGroupName": "Clothes specifications"
}

Response

OK

integer required

Specification field ID.