PUT
/
datasets
/
{dataset_id}
/
fields
/
{field_id}
cURL
curl --request PUT \
  --url https://api.axiom.co/v2/datasets/{dataset_id}/fields/{field_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "hidden": true,
  "name": "<string>",
  "type": "<string>",
  "unit": "<string>"
}'
{
  "description": "<string>",
  "hidden": true,
  "name": "<string>",
  "type": "<string>",
  "unit": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
dataset_id
string
required
​
field_id
string
required

Body

application/json
​
name
string
required

Name of the field

​
type
string
required

Type of the field

​
description
string

Description of the field

​
hidden
boolean

Whether the field is hidden

​
unit
string

Unit of the field

Response

200 - application/json

DatasetField

​
name
string
required

Name of the field

​
type
string
required

Type of the field

​
description
string

Description of the field

​
hidden
boolean

Whether the field is hidden

​
unit
string

Unit of the field