---
title: "Update field metadata"
method: PUT
path: "/fields/{field_id}/metadata"
tags: ["Fields"]
---

# Update field metadata

`PUT /fields/{field_id}/metadata`

## Request

- Base URL: `https://us.app.zuva.ai/api/v2`
- URL: `https://us.app.zuva.ai/api/v2/fields/{field_id}/metadata`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/zuva/apis/zuva-docai/docs/fields/:field_id/metadata/put.ts> (a function with typed inputs; its response is checked against the schema)

Update the name and description of a custom field.

## Path parameters

- `field_id` string, required

## Request body

- PutFieldMetadataRequest
  - `description` string
  - `name` string

## Response `204`

The metadata for the field was successfully updated

## Other responses

- `400`: Invalid field ID
- `404`: Field not found.
- `405`: Cannot update a read-only field
- `500`: Internal Server Error

---

[API](https://skmtc.dev/zuva/apis/zuva-docai.md) - [All operations](https://skmtc.dev/zuva/apis/zuva-docai/llms.txt) - [OpenAPI document](https://skmtc.dev/zuva/apis/zuva-docai/revisions/7397ad071d55?raw)