Web API

Press shift + S to search API reference.

Records

Update record

patchputhttps://api.airtable.com/v0/{baseId}/{tableIdOrName}/{recordId}

Updates a single record. Table names and table ids can be used interchangeably. We recommend using table IDs so you don't need to modify your API request when your table name changes. A PATCH request will only update the fields you specify, leaving the rest as they were. A PUT request will perform a destructive update and clear all unspecified cell values.

Your request body should include a fields property whose value is an object containing your record's cell values, keyed by either field name or field id.

Automatic data conversion for update actions can be enabled via typecast parameter. The Airtable API will perform best-effort automatic data conversion from string values 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.

Requirements

AuthenticationPersonal access token, OAuth integration
Scopedata.records:write
User role

Base editor

Billing plansAll plans

Path parameters

baseId
string
tableIdOrName
string
recordId
string

Request body

returnFieldsByFieldId
optional<boolean>

An optional boolean value that lets you return field objects keyed by the field id.

This defaults to false, which returns field objects where the key is the field name.

typecast
optional<boolean>

The Airtable API will perform best-effort automatic data conversion from string values 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.

fields
object
key: stringany

Response format

id
string

Record ID

createdTime
string

A date timestamp in the ISO format, eg:"2018-01-01T00:00:00.000Z"

fields
object

Cell values are keyed by either field name or field ID (conditioned on returnFieldsByFieldId).

See Cell Values for more information on cell value response types.

key: stringCell value
Request (example)
Copy
$
curl -X PATCH "https://api.airtable.com/v0/{baseId}/{tableIdOrName}/{recordId}" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"fields": {
"Address": "1 Ferry Building",
"Name": "Ferry Building",
"Visited": true
}
}'
200 – Response (example)
{
"createdTime": "2022-09-12T21:03:48.000Z",
"fields": {
"Address": "1 Ferry Building",
"Name": "Ferry Building",
"Visited": true
},
"id": "rec3lbPRG4aVqkeOQ"
}