PATCH
/
table
/
{tableId}
/
record
/
{recordId}
curl --request PATCH \
  --url https://app.teable.io/api/table/%7BtableId%7D/record/%7BrecordId%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"fieldKeyType":"id","typecast":true,"record":{"fields":{"property1":null,"property2":null}},"order":{"viewId":"string","anchorId":"string","position":"before"}}'
{
  "id": "<string>",
  "name": "<string>",
  "fields": {},
  "autoNumber": 123,
  "createdTime": "<string>",
  "lastModifiedTime": "<string>",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
tableId
string
required
​
recordId
string
required

Body

application/json

Update record by id

​
record
object
required
​
fieldKeyType
enum<string>
default:
name

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

Available options:
id,
name
​
typecast
boolean

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.

​
order
object

Where this record to insert to (Optional)

Response

200 - application/json
Returns record data after update.
​
id
string
required

The record id.

​
fields
object
required

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

​
name
string

primary field value

​
autoNumber
number

Auto number, a unique identifier for each record

​
createdTime
string

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

​
lastModifiedTime
string

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

​
createdBy
string

Created by, user name

​
lastModifiedBy
string

Last modified by, user name

Previous
List records
Next