PUT
/
table
/
{tableId}
/
field
/
{fieldId}
/
convert
shell
curl --request PUT \
  --url https://app.teable.cn/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"}},"aiConfig":{"modelKey":"string","isAutoFill":true,"attachPrompt":"string","type":"extraction","sourceFieldId":"string"}}'
{
  "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"
    }
  },
  "aiConfig": {
    "modelKey": "<string>",
    "isAutoFill": true,
    "attachPrompt": "<string>",
    "type": "extraction",
    "sourceFieldId": "<string>"
  },
  "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>",
  "recordRead": true,
  "recordCreate": true
}

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

Response

200 - application/json

Returns field data after update.

The response is of type object.