Skip to main content
Rename a data table column, or change its key, currency, options or default, and return the table as get_data_table serves it, the column also as field. Pass at least one of name, key, currency_key, options or default. Re-sending the current values changes nothing. options is the column’s whole list, not an addition to it: read the column’s current options with get_data_table first. An option left out is removed and its value cleared from every record that held it, as when an option is removed in the Qobra web app. An option cannot be renamed: a new label is a new option, and the records holding the old one lose that value. Removing the option the default names also clears the default. A new key changes how Qobra’s public API and Excel imports address the column. The reports and the lookups reading the column follow a rename. A column’s type and description cannot be changed. The call is refused when:
  • key, options or default is passed for a column synced from an integration, which takes them from the source.
  • key, currency_key, options or default is passed for a lookup, which takes them and its currency from the column it reads.
  • currency_key is passed for a column that is not an amount, or options for one that is not a picklist or a multipicklist.
  • the new key is already carried by another column of the table, or normalizes to nothing.
  • default does not match the column’s type or is not one of its options, or is an empty string on a bool column, whose default is always true or false.
Requires write permission on data tables. Every write is recorded in the audit trail as the Qobra MCP agent.
Example arguments

Parameters

Body

string
required
Id of the column: the id of a field from get_data_table or create_data_table_field, never a name or a key.
string
New display name. Omit to keep the current one.
string
New key of the column in the public API and Excel imports. Lowercase letters, digits and _ only, stored as sent, unique within the table. Omit to keep the current key.
string
Amount only: the key of the column each row’s currency code is read from, not a currency code. Pass "" to clear it (the company currency again). Omit to keep it.
string[]
Picklist or multipicklist only: the complete list of labels, in order, not only the new ones. A label already offered is kept, a new one is added, one left out is removed and cleared from every record holding it. Omit to keep the options.
string | number | boolean | string[]
The value records created from now on start with, typed like the column: text, a number for float / amount / percentage, true/false, an ISO date (‘2026-03-14’), one label of the options for a picklist, a list of labels for a multipicklist. Existing records keep their values. Pass "" to clear it, except on a bool column, whose default is always true or false. Omit to keep it.

Response

Body

object
The table as get_data_table returns it, the updated column included. See get_data_table for the field breakdown.
object
The column as it now stands: which of data_table.fields is the updated one, so it is at hand without matching on a name.