Skip to main content
PUT
cURL

Autorisierungen

Authorization
string
header
erforderlich

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

Pfadparameter

tableId
string
erforderlich
fieldId
string
erforderlich

Body

application/json
type
enum<string>
erforderlich

The field types supported by teable.

Verfügbare Optionen:
singleLineText,
longText,
user,
attachment,
checkbox,
multipleSelect,
singleSelect,
date,
number,
rating,
formula,
rollup,
conditionalRollup,
link,
createdTime,
lastModifiedTime,
createdBy,
lastModifiedBy,
autoNumber,
button
Beispiel:

"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.

Beispiel:

"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.

Antwort

201 - application/json

Returns the calculation plan

estimateTime
number
graph
object
updateCellCount
number
skip
boolean
Zuletzt geändert am 4. September 2026