update_table_column
Rename a column, change its type, or edit its options and flags.
A type change converts every existing value (for example text "12" → number
12). One value that cannot be converted aborts the whole change, so nothing
is half-applied. In the in-product agent a type change opens the approval
modal.
Parameters#
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
table_id | string | yes | The table id | |
column_id | string | yes | The column id from get_table — not the column key | |
name | string | no | New display name | |
data_type | string | no | New type: text, number, date, datetime, boolean, select, multi_select, email, url, … | |
config | object | no | For select / multi_select: {"options": [{"value": "x"}]} | |
is_required | boolean | no | Whether a row must have a value here | |
is_hidden | boolean | no | Hide the column from the default grid view |
Returns#
The table schema — same shape as get_table.
Errors#
error_type | When |
|---|---|
auth_error | Missing / invalid API key |
invalid_request | Nothing to change, or an empty name |
unknown_column | column_id is not on this table |
invalid_column_type | Unknown type, or a value that cannot be converted to the new type |
not_found | Unknown or platform-managed table |