Tables

Update a field

Change a field’s label, kind, config, format, default or formula source. A retype re-reads every dependent value, so the response is the table as it now stands.

patch/v1/tables/{tableId}/fields/{fieldId}

Request

  • Base URL: https://api.banksync.io
  • URL: https://api.banksync.io/v1/tables/{tableId}/fields/{fieldId}
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

tableIdstring required

Table ID

fieldIdstring required

Field ID

Request body

labelstring
kind'text' | 'long_text' | 'number' | 'checkbox' | 'date' | 'datetime' | 'single_select' | 'multi_select' | 'status' | 'url' | 'email' | 'phone' | 'rating' | 'user' | 'auto_number' | 'attachment' | 'json' | 'relation' | 'formula' | 'created_time' | 'last_edited_time' | 'created_by' | 'last_edited_by'
configobject
requiredboolean
uniqueboolean
iconstring nullable
descriptionstring nullable
sourcestring
expectedSchemaVersioninteger required
dashboardImpactDecision'break'
dashboardImpactTokenstring

Response

Field updated

successtrue required

Changes

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