---
title: "Create a field description for a Dataset"
method: POST
path: "/{account}/datasets/{dataset}/field_descriptions"
---

# Create a field description for a Dataset

`POST /{account}/datasets/{dataset}/field_descriptions`

## Request

- Base URL: `https://modeanalytics.com/api`
- URL: `https://modeanalytics.com/api/{account}/datasets/{dataset}/field_descriptions`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/thoughtspot/apis/mode/docs/:account/datasets/:dataset/field_descriptions/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a field description for a `Dataset` with the provided parameters

## Path parameters

- `account` string, required
- `dataset` string, required

## Request body

- CreateDatasetFieldDescriptionBody
  - `field_description` object, required: The parameters for updating the field description
    - `desc` string: The description of the field
    - `name` string: The name of the field

## Response `200`

`DatasetFieldDescription` response

- DatasetFieldDescription (unresolved $ref)

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `404`: `Dataset` not found

## Changes

- **2023-09-20** `e2442e7b8364`: 1 info
  - added the non-success response with the status `400`
- **2023-09-15** `10b433a59970`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/thoughtspot/apis/mode/changes/:account/datasets/:dataset/field_descriptions/post.md)

---

[API](https://skmtc.dev/thoughtspot/apis/mode.md) - [All operations](https://skmtc.dev/thoughtspot/apis/mode/llms.txt) - [OpenAPI document](https://skmtc.dev/thoughtspot/apis/mode/revisions/4c694c3fdeb1?raw)