Updates the name and/or description of a field. At least one of name or description must be specified.
Fields
Update field
patch
https://api.airtable.com/v0/meta/bases/{baseId}/tables/{tableId}/fields/{columnId}
Authentication | Personal access token, OAuth integration |
Scope | schema.bases:write |
User role | Base creator |
Billing plans | All plans |
optional< string > The new description for the field (optional). If present, must be a string no longer than 20,000 characters. | |
optional< string > The new name for the field (optional). |
string | |
optional< Field > | |
string | |
optional< string > | |
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"}