---
title: "Api Update Table Description"
method: PUT
path: "/api/table-descriptions/{id}"
tags: ["Table Description"]
---

# Api Update Table Description

`PUT /api/table-descriptions/{id}`

## Request

- The document declares no server URL.
- Auth: API key in header `X-API-Key`

## Path parameters

- `id` string, required

## Request body

- TableDescriptionRequest
  - `description` string
  - `columns` ColumnDescription[]
    - `name` string
    - `description` string
    - `is_primary_key` boolean
    - `data_type` string
    - `low_cardinality` boolean
    - `categories` string[]
    - `foreign_key` object
  - `examples` unknown[]
    - unknown
  - `metadata` object

## Response `200`

Successful Response

- TableDescriptionResponse
  - `id` string, required
  - `db_connection_id` string
  - `description` string
  - `columns` ColumnDescription[]
    - `name` string
    - `description` string
    - `is_primary_key` boolean
    - `data_type` string
    - `low_cardinality` boolean
    - `categories` string[]
    - `foreign_key` object
  - `examples` unknown[]
    - unknown
  - `table_name` string
  - `status` 'NOT_SYNCHRONIZED' | 'SYNCHRONIZING' | 'SYNCHRONIZED' | 'DEPRECATED' | 'FAILED': An enumeration.
  - `last_schema_sync` string, date-time
  - `created_at` string, date-time
  - `metadata` TableDescriptionMetadata
    - `dh_internal` object

## Other responses

- `404`: Not found
- `422`: Validation Error

---

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