Web API

Press shift + S to search API reference.

Tables

Update table

patchhttps://api.airtable.com/v0/meta/bases/{baseId}/tables/{tableIdOrName}

Updates the name and/or description of a table. 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
tableIdOrName
string

Request body

description
optional<string>

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

name
optional<string>

The new name for the table (optional).

Response format

id
string
primaryFieldId
string

The first column in the table and every view.

name
string
description
optional<string>
fields
array of the below object
id
string
type
optional<Field Type>
name
string
description
optional<string>
options
optional<Field options>
views
array of the below object
id
string
type
"grid" | "form" | "calendar" | "gallery" | "kanban" | "timeline" | "block"

View type, block is Gantt View

name
string
visibleFieldIds
optional<array of strings>

Available on grid views only: list of visible (non-hidden) field IDs, when requested with include query paremeter

Request (example)
Copy
$
curl -X PATCH "https://api.airtable.com/v0/meta/bases/{baseId}/tables/{tableIdOrName}" \
-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!",
"fields": [
{
"id": "fld1VnoyuotSTyxW1",
"name": "Name",
"type": "singleLineText"
},
{
"id": "fldoi0c3GaRQJ3xnI",
"name": "Address",
"type": "singleLineText"
},
{
"id": "fldumZe00w09RYTW6",
"name": "Visited",
"options": {
"color": "redBright",
"icon": "star"
},
"type": "checkbox"
}
],
"id": "tbltp8DGLhqbUmjK1",
"name": "Apartments (revised)",
"primaryFieldId": "fld1VnoyuotSTyxW1",
"views": [
{
"id": "viwQpsuEDqHFqegkp",
"name": "Grid view",
"type": "grid"
}
]
}