field

Update field

Update common properties of a field (name, description, dbFieldName). For other property changes, use the convert field API

patch/table/{tableId}/field/{fieldId}

Request

Base URL
https://app.teable.ai/api
Auth
HTTP bearer
TypeScript
https://skmtc.dev/teable/apis/teable-app/docs/table/:tableId/field/:fieldId/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

tableIdstring required

fieldIdstring required

Request body

namestring

descriptionstring nullable

The description of the field.

dbFieldNamestring

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.

Example request

{
  "description": "this is a summary"
}

Response

Updated Successfully

Changes

No recorded changes to this operation across all 1 revision of this API.