PUT
/
table
/
{tableId}
/
field
/
{fieldId}
/
convert
curl --request PUT \
  --url https://app.teable.io/api/table/%7BtableId%7D/field/%7BfieldId%7D/convert \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"type":"singleSelect","name":"Tags","unique":true,"notNull":true,"dbFieldName":"string","isLookup":true,"description":"this is a summary","lookupOptions":{"foreignTableId":"string","lookupFieldId":"string","linkFieldId":"string","filter":{}},"options":{"expression":"countall({values})","timeZone":"string","formatting":{"date":"string","time":"HH:mm","timeZone":"string"},"showAs":{"type":"url"}}}'
{
  "id": "<string>",
  "name": "Tags",
  "type": "singleSelect",
  "description": "this is a summary",
  "options": {
    "expression": "countall({values})",
    "timeZone": "<string>",
    "formatting": {
      "date": "<string>",
      "time": "HH:mm",
      "timeZone": "<string>"
    },
    "showAs": {
      "type": "url"
    }
  },
  "isLookup": true,
  "lookupOptions": {
    "foreignTableId": "<string>",
    "lookupFieldId": "<string>",
    "relationship": "oneOne",
    "fkHostTableName": "<string>",
    "selfKeyName": "<string>",
    "foreignKeyName": "<string>",
    "filter": {},
    "linkFieldId": "<string>"
  },
  "notNull": true,
  "unique": true,
  "isPrimary": true,
  "isComputed": true,
  "isPending": true,
  "hasError": true,
  "cellValueType": "string",
  "isMultipleCellValue": true,
  "dbFieldType": "TEXT",
  "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

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

​
type
enum<string>
required

The field types supported by teable.

Available options:
singleLineText,
longText,
user,
attachment,
checkbox,
multipleSelect,
singleSelect,
date,
number,
duration,
rating,
formula,
rollup,
count,
link,
createdTime,
lastModifiedTime,
createdBy,
lastModifiedBy,
autoNumber,
button
​
name
string

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

Minimum 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 length: 1
​
isLookup
boolean

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

​
description
string | null

The description of the field.

​
lookupOptions
object

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

​
options
object

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

Response

200 - application/json
Returns field data after update.
​
id
string
required

The id of the field.

​
name
string
required

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

​
type
enum<string>
required

The field types supported by teable.

Available options:
singleLineText,
longText,
user,
attachment,
checkbox,
multipleSelect,
singleSelect,
date,
number,
duration,
rating,
formula,
rollup,
count,
link,
createdTime,
lastModifiedTime,
createdBy,
lastModifiedBy,
autoNumber,
button
​
options
object
required

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

​
cellValueType
enum<string>
required

The cell value type of the field.

Available options:
string,
number,
boolean,
dateTime
​
dbFieldType
enum<string>
required

The field type of database that cellValue really store.

Available options:
TEXT,
INTEGER,
DATETIME,
REAL,
BLOB,
JSON,
BOOLEAN
​
dbFieldName
string
required

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
​
description
string

The description of the field.

​
isLookup
boolean

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

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

Previous
Get linked records for filter
Next