datasets

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

Changed on Oct 16, 2026

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.

Request

Base URL
https://api.axiom.co/v2
Auth
OAuth 2
Authorization codehttps://accounts.google.com/o/oauth2/v2/auth
Token URLhttps://www.googleapis.com/oauth2/v4/token
Scopesdatasets|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.

Path parameters

dataset_idstring required

field_idstring required

Request body

descriptionstring

Description of the field

hiddenboolean

Whether the field is hidden

namestring required

Name of the field

typestring required

Type of the field

unitstring

Unit of the field

Response

Updated field.