---
title: "PUT /datasets/{dataset_id}/fields/{field_id}"
method: PUT
path: "/datasets/{dataset_id}/fields/{field_id}"
tags: ["datasets"]
---

# PUT /datasets/{dataset_id}/fields/{field_id}

`PUT /datasets/{dataset_id}/fields/{field_id}`

## Request

- Base URL: `https://api.axiom.co/v2`
- URL: `https://api.axiom.co/v2/datasets/{dataset_id}/fields/{field_id}`
- Auth: OAuth 2
  - Authorization code: `https://accounts.google.com/o/oauth2/v2/auth`
  - Token URL: `https://www.googleapis.com/oauth2/v4/token` scopes: `datasets|update`
- TypeScript: <https://skmtc.dev/axiom/apis/axiom-public-api/docs/datasets/:dataset_id/fields/:field_id/put.ts> (a function with typed inputs; its response is checked against the schema)

Updates the `unit`, `description`, and `hidden` settings of a field. All three are replaced, so omitted values are cleared. The `name` and `type` in the body are ignored.

## Path parameters

- `dataset_id` string, required
- `field_id` string, required

## Request body

- DatasetField
  - `description` string: Description of the field
  - `hidden` boolean: Whether the field is hidden
  - `name` string, required: Name of the field
  - `type` string, required: Type of the field
  - `unit` string: Unit of the field

## Response `200`

Updated field.

- DatasetField
  - `description` string: Description of the field
  - `hidden` boolean: Whether the field is hidden
  - `name` string, required: Name of the field
  - `type` string, required: Type of the field
  - `unit` string: Unit of the field

## Other responses

- `400`: A metrics dataset or a dataset managed by Axiom.
- `403`: Forbidden
- `404`: The dataset doesn't exist or the field isn't in its schema.

## Changes

- **2026-10-16** (v2) `fbc1b8430feb`: 3 info
  - added the non-success response with the status `400`
  - added the non-success response with the status `403`
  - added the non-success response with the status `404`

[Operation history](https://skmtc.dev/axiom/apis/axiom-public-api/changes/datasets/:dataset_id/fields/:field_id/put.md)

---

[API](https://skmtc.dev/axiom/apis/axiom-public-api.md) - [All operations](https://skmtc.dev/axiom/apis/axiom-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/axiom/apis/axiom-public-api/revisions/7e39a295e3ba?raw)