Skip to main content
PATCH
Update field
The template object structure varies by field type - see Field Types Reference for complete details

Select options

For single_select and multiple_select fields, template.options merges into the existing options rather than replacing them:
  • An option that matches an existing one by value or label updates it. Any other option is added.
  • Options you leave out are kept. List every option to reorder them.
  • To delete options, pass template.removeOptions: option IDs or labels, or objects that say what happens to records still using the option.
A plain removal (like "Draft") is refused with 409 Conflict while any record uses the option. reassignTo moves those records to another option, and clear: true empties the value. A request that uses reassignTo or clear can only change the field’s options, so send other changes (like a rename) separately.

Authorizations

Authorization
string
header
required

Enter your Zite API key. Format: Bearer <api_key>

Path Parameters

databaseId
string
required

The unique identifier of the database

tableId
string
required

The unique identifier of the table. You can also use the table name instead of the ID.

fieldId
string
required

The unique identifier of the field. You can also use the field name instead of the ID.

Body

application/json
name
string

New field name

Minimum string length: 1
template
object

Updated field configuration. See Field types for the template of each type. For select fields, options you list are matched to existing options by value or label and updated; options you leave out are kept (listing every option reorders them). To delete options, pass removeOptions: an array of option IDs or labels, or objects like { "option": "Done", "reassignTo": "Open" } or { "option": "Done", "clear": true }. A plain removal is refused while records still use the option.

type
enum<string>

Field type. See Field types for the value shape and template of each type.

Available options:
single_line_text,
long_text,
rich_text,
email,
url,
phone_number,
number,
currency,
percent,
rating,
duration,
single_select,
multiple_select,
checkbox,
date,
datetime,
attachments,
linked_record,
lookup,
rollup,
formula,
autonumber,
source,
created_at,
updated_at,
created_by,
updated_by,
user

Response

Field updated successfully

id
string
required

Unique identifier for the field

name
string
required

Name of the field

type
enum<string>
required

Field type. See Field types for the value shape and template of each type.

Available options:
single_line_text,
long_text,
rich_text,
email,
url,
phone_number,
number,
currency,
percent,
rating,
duration,
single_select,
multiple_select,
checkbox,
date,
datetime,
attachments,
linked_record,
lookup,
rollup,
formula,
autonumber,
source,
created_at,
updated_at,
created_by,
updated_by,
user
template
object
required

Field-specific configuration options. See Field types for detailed template structure by field type.

order
integer
required

Display order of the field