---
title: "Update field by id"
method: PUT
path: "/api/v11/Field/{id}"
tags: ["Field"]
---

# Update field by id

`PUT /api/v11/Field/{id}`

## Request

- Base URL: `https://indexing-dev.hawksearch.net`
- URL: `https://indexing-dev.hawksearch.net/api/v11/Field/{id}`
- Auth: none declared. Required headers: `X-HawkSearch-ApiKey`
- TypeScript: <https://skmtc.dev/hawksearch/apis/hawksearch-elasticsearch-indexingapi/docs/api/v11/Field/:id/put.ts> (a function with typed inputs; its response is checked against the schema)

Updates a single field by its id

## Path parameters

- `id` integer, required

## Headers

- `X-HawkSearch-ApiKey` string, required

## Request body

- FieldModel
  - `FieldId` integer
  - `SyncGuid` string, uuid
  - `Label` string
  - `Name` string, required
  - `IsPrimaryKey` boolean, required
  - `Type` string
  - `FieldType` string, required
  - `Boost` integer
  - `FacetHandler` integer
  - `IsOutput` boolean, required
  - `IsShingle` boolean, required
  - `IsBestFragment` boolean, required
  - `IsDictionary` boolean, required
  - `IsSort` boolean, required
  - `IsPrefix` boolean
  - `IsHidden` boolean, required
  - `IsCompare` boolean, required
  - `SortOrder` integer
  - `PartialQuery` string
  - `IsKeywordText` boolean, required
  - `IsQuery` boolean, required
  - `IsQueryText` boolean, required
  - `SkipCustom` boolean, required
  - `StripHtml` boolean, required
  - `MinNGramAnalyzer` integer
  - `MaxNGramAnalyzer` integer
  - `CoordinateType` integer
  - `OmitNorms` boolean
  - `ItemMapping` string
  - `DefaultValue` string
  - `UseForPrediction` boolean
  - `CopyTo` string
  - `Analyzer` string
  - `DoNotStore` boolean
  - `Tags` string
  - `Iterations` integer[]
  - `AnalyzerLanguage` string
  - `PreviewMapping` string
  - `OmitTfAndPos` boolean
  - `CreateDate` string, date-time
  - `ModifyDate` string, date-time
  - `IsChild` boolean
  - `IsHierarchical` boolean

## Response `200`

OK

- object

---

[API](https://skmtc.dev/hawksearch/apis/hawksearch-elasticsearch-indexingapi.md) - [All operations](https://skmtc.dev/hawksearch/apis/hawksearch-elasticsearch-indexingapi/llms.txt) - [OpenAPI document](https://skmtc.dev/hawksearch/apis/hawksearch-elasticsearch-indexingapi/revisions/24cba7bf3468?raw)