---
title: "Edit Field"
method: PATCH
path: "/fields/{fieldId}"
tags: ["Fields"]
---

# Edit Field

`PATCH /fields/{fieldId}`

## Request

- Base URL: `https://api.crowdin.com/api/v2`
- URL: `https://api.crowdin.com/api/v2/fields/{fieldId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/crowdin/apis/crowdin-enterprise-api-v2/docs/fields/:fieldId/patch.ts> (a function with typed inputs; its response is checked against the schema)

**Required scopes:** `field` (Read and Write).

## Path parameters

- `fieldId` integer, required

## Request body

- FieldOperation[]: A JSON Patch document as defined by <a href="https://tools.ietf.org/html/rfc6902#section-3" target="_blank">RFC 6902</a>
  - `op` 'replace', required: Patch operation to perform
  - `path` '/name' | '/description' | '/config' | '/entities', json-pointer, required: A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>

## Response `200`

Field was successfully updated

- FieldResource: Base schema of resource container. Container is a wrapper object that contains payload in required `data` property and provides space for adding any other metadata.
  - `data` Field, required: Class FieldResponseModel
    - `id` integer
    - `name` string
    - `slug` string
    - `description` string
    - `type` string
    - `config` object
    - `entities` string[]: Entities that will be associated with field
    - `createdAt` string, date-time: in UTC
    - `updatedAt` string, date-time: in UTC

## Other responses

- `400`: Invalid Request Body
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Field with specified id was not found
- `405`: Method Not Allowed
- `500`: Internal Server Error
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crowdin/apis/crowdin-enterprise-api-v2.md) - [All operations](https://skmtc.dev/crowdin/apis/crowdin-enterprise-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/crowdin/apis/crowdin-enterprise-api-v2/revisions/dc68744c5384?raw)