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

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

The name of the field. can not be duplicated in the table.

Minimum length: 1
​
description
string | null

The description of the field.

​
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 length: 1
Previous
Convert field type
Next