v1

latestOpenAPI 3.0.02026-07-2638801.8 MB

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}

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