record

Update multiple records

Update multiple records in a single request with support for field value typecast and record reordering.

patch/table/{tableId}/record

Request

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

Path parameters

tableIdstring required

Request body

fieldKeyType'id' | 'name' | 'dbFieldName'

Define the key type of record.fields[key], You can click "systemInfo" in the field edit box to get fieldId or enter the table design screen with all the field details

typecastboolean

Automatic data conversion from cellValues if the typecast parameter is passed in. Automatic conversion is disabled by default to ensure data integrity, but it may be helpful for integrating with 3rd party data sources.

Response

Returns the records data after update.

idstring required

The record id.

namestring

primary field value

fieldsobject required

Objects with a fields key mapping fieldId or field name to value for that field.

autoNumbernumber

Auto number, a unique identifier for each record

createdTimestring

Created time, date ISO string (new Date().toISOString).

lastModifiedTimestring

Last modified time, date ISO string (new Date().toISOString).

createdBystring

Created by, user name

lastModifiedBystring

Last modified by, user name

permissionsobject

Permissions for the record

undeletableboolean

Whether the record is undeletable

Changes

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