Skip to main content
PATCH
/
table
/
{tableId}
/
field
/
{fieldId}
cURL
curl --request PATCH \
  --url https://app.teable.ai/api/table/%7BtableId%7D/field/%7BfieldId%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"name":"string","description":"this is a summary","dbFieldName":"string"}'

Documentation Index

Fetch the complete documentation index at: https://help.teable.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
tableId
string
required
​
fieldId
string
required

Body

application/json
​
name
string
Minimum string length: 1
​
description
string | null

The description of the field.

Example:

"this is a summary"

​
dbFieldName
string

Field(column) name in backend database. Limitation: 1-63 characters, can only contain letters, numbers and underscore, case sensitive, cannot be duplicated with existing db field name in the table.

Minimum string length: 1
Pattern: ^\w{0,63}$

Response

200

Updated Successfully

Last modified on March 5, 2026