Web API

Press shift + S to search API reference.

Fields

Update field

patchhttps://api.airtable.com/v0/meta/bases/{baseId}/tables/{tableId}/fields/{columnId}

Updates the name and/or description of a field. At least one of name or description must be specified.

Requirements

AuthenticationPersonal access token, OAuth integration
Scopeschema.bases:write
User role

Base creator

Billing plansAll plans

Path parameters

baseId
string
tableId
string
columnId
string

Request body

description
optional<string>

The new description for the field (optional). If present, must be a string no longer than 20,000 characters.

name
optional<string>

The new name for the field (optional).

Response format

id
string
type
optional<Field Type>
name
string
description
optional<string>
options
optional<Field options>
Request (example)
Copy
$
curl -X PATCH "https://api.airtable.com/v0/meta/bases/{baseId}/tables/{tableId}/fields/{columnId}" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"description": "I was changed!",
"name": "Apartments (revised)"
}'
200 – Response (example)
{
"description": "I was changed!",
"id": "fldoi0c3GaRQJ3xnI",
"name": "Name (revised)",
"type": "singleLineText"
}