Skip to main content
PUT
cURL

Autorisations

Authorization
string
header
requis

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

Paramètres de chemin

tableId
string
requis
fieldId
string
requis

Corps

application/json

Provide the complete field configuration including all properties, modified or not

type
enum<string>
requis

The field types supported by teable.

Options disponibles:
singleLineText,
longText,
user,
attachment,
checkbox,
multipleSelect,
singleSelect,
date,
number,
rating,
formula,
rollup,
conditionalRollup,
link,
createdTime,
lastModifiedTime,
createdBy,
lastModifiedBy,
autoNumber,
button
Exemple:

"singleSelect"

name
string
Minimum string length: 1
unique
boolean

Whether this field is not unique.

notNull
boolean

Whether this field is not null.

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}$
isLookup
boolean

Whether this field is lookup field. witch means cellValue and [fieldType] is looked up from the linked table.

isConditionalLookup
boolean

Whether this lookup field applies a conditional filter when resolving linked records.

description
string | null

The description of the field.

Exemple:

"this is a summary"

lookupOptions
object

The lookup options for field, you need to configure it when isLookup attribute is true or field type is rollup.

options

The options of the field. The configuration of the field's options depend on the it's specific type.

aiConfig

The AI configuration of the field.

Réponse

200 - application/json

Returns field data after update.

id
string
requis

The id of the field.

name
string
requis

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

Exemple:

"Tags"

type
enum<string>
requis

The field types supported by teable.

Options disponibles:
singleLineText,
longText,
user,
attachment,
checkbox,
multipleSelect,
singleSelect,
date,
number,
rating,
formula,
rollup,
conditionalRollup,
link,
createdTime,
lastModifiedTime,
createdBy,
lastModifiedBy,
autoNumber,
button
Exemple:

"singleSelect"

options
object
requis

The configuration options of the field. The structure of the field's options depend on the field's type.

cellValueType
enum<string>
requis

The cell value type of the field.

Options disponibles:
string,
number,
boolean,
dateTime
dbFieldType
enum<string>
requis

The field type of database that cellValue really store.

Options disponibles:
TEXT,
INTEGER,
DATETIME,
REAL,
BLOB,
JSON,
BOOLEAN
dbFieldName
string
requis

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}$
description
string

The description of the field.

Exemple:

"this is a summary"

meta
object

The metadata of the field. The structure of the field's meta depend on the field's type. Currently formula and link fields have meta.

aiConfig

The AI configuration of the field.

isLookup
boolean

Whether this field is lookup field. witch means cellValue and [fieldType] is looked up from the linked table.

isConditionalLookup
boolean

Whether this lookup field applies a conditional filter when resolving linked records.

lookupOptions
object

field lookup options.

notNull
boolean

Whether this field is not null.

unique
boolean

Whether this field is not unique.

isPrimary
boolean

Whether this field is primary field.

isComputed
boolean

Whether this field is computed field, you can not modify cellValue in computed field.

isPending
boolean

Whether this field's calculation is pending.

hasError
boolean

Whether This field has a configuration error. Check the fields referenced by this field's formula or configuration.

isMultipleCellValue
boolean

Whether this field has multiple cell value.

recordRead
boolean

Field record read permission. When set to false, reading records is denied. When true or not set, reading records is allowed.

recordCreate
boolean

Field record create permission. When set to false, creating records is denied. When true or not set, creating records is allowed.

Dernière modification le 4 septembre 2026