action vtex_specifications_insert_field {
  label: "Create Specification Field"
  description: "Creates a specification field in a category. 
\n>⚠️ This is a legacy endpoint. We recommend using [Create Specification](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-post-specification) instead.
\n
\n## Request body example
\n
\n```json
\n{
\n    \"Name\": \"Material\",
\n    \"CategoryId\": 4,
\n    \"FieldId\": 88,
\n    \"IsActive\": true,
\n    \"IsRequired\": true,
\n    \"FieldTypeId\": 1,
\n    \"FieldValueId\": 1,
\n    \"IsStockKeepingUnit\": false,
\n    \"Description\": \"Composition of the product.\",
\n    \"IsFilter\": true,
\n    \"IsOnProductDetails\": false,
\n    \"Position\": 1,
\n    \"IsWizard\": false,
\n    \"IsTopMenuLinkActive\": true,
\n    \"IsSideMenuLinkActive\": true,
\n    \"DefaultValue\": null,
\n    \"FieldGroupId\": 20,
\n    \"FieldGroupName\": \"Clothes specifications\"
\n}
\n```
\n
\n## Response body example
\n
\n```json
\n89
\n```"
  provider: vtex
  method: POST
  path: "/api/catalog_system/pvt/specification/field"
  encoding: json
  input: {
    type: "object"
    properties: {
      Accept: {
        type: "string"
      }
      CategoryId: {
        type: "integer"
        description: "Category ID."
      }
      "Content-Type": {
        type: "string"
      }
      DefaultValue: {
        type: "string"
        description: "Specification Field default Value."
      }
      Description: {
        type: "string"
        description: "Specification Field Description."
      }
      FieldGroupId: {
        type: "integer"
        format: "int32"
        description: "Specification Field Group ID."
      }
      FieldGroupName: {
        type: "string"
        description: "Specification Field Group Name."
      }
      FieldId: {
        type: "integer"
        description: "Specification Field ID."
      }
      FieldTypeId: {
        type: "integer"
        format: "int32"
        description: "Specification Field Type ID."
      }
      FieldValueId: {
        type: "integer"
        description: "Specification Field Value ID."
      }
      IsActive: {
        type: "boolean"
        description: "Defines if the Specification Field is active. The default value is `true`."
      }
      IsFilter: {
        type: "boolean"
        description: "Store Framework - Deprecated.
\nLegacy CMS Portal - To allow the specification to be used as a facet (filter) on the search navigation bar.
\n"
      }
      IsOnProductDetails: {
        type: "boolean"
        description: "Store Framework - Deprecated.
\nLegacy CMS Portal -If specification is visible on the product page.
\n"
      }
      IsRequired: {
        type: "boolean"
        description: "Makes the Specification Field mandatory (`true`) or optional (`false`)."
      }
      IsSideMenuLinkActive: {
        type: "boolean"
        description: "Store Framework - Deprecated.
\nLegacy CMS Portal - To make the specification field clickable in the search navigation bar.
\n"
      }
      IsStockKeepingUnit: {
        type: "boolean"
        description: "If `true`, it will be added as a SKU specification. If `false`, it will be added as a product specification field."
      }
      IsTopMenuLinkActive: {
        type: "boolean"
        description: "Store Framework - Deprecated.
\nLegacy CMS Portal - To make the specification visible in the store's upper menu.
\n"
      }
      IsWizard: {
        type: "boolean"
        description: "Deprecated field."
      }
      Name: {
        type: "string"
        description: "Specification Field ID."
      }
      Position: {
        type: "integer"
        format: "int32"
        description: "Specification Field Position."
      }
    }
    required: ["Accept", "CategoryId", "Content-Type", "DefaultValue", "Description", "FieldGroupId", "FieldGroupName", "FieldId", "FieldTypeId", "FieldValueId", "IsActive", "IsFilter", "IsOnProductDetails", "IsRequired", "IsSideMenuLinkActive", "IsStockKeepingUnit", "IsTopMenuLinkActive", "IsWizard", "Name", "Position"]
    additionalProperties: false
  }
  output: {
    type: "integer"
    description: "Specification field ID."
  }
}