Skip to main content
Add one column to a data table, and return the table as it now stands. The column is created empty on every existing record: this sets no values and no default. It is added to the table’s views, to the scopes reading that table and to the plans’ simulation pipelines, so it is available to a compensation and to a report straight away — load its values by Excel import from the Qobra web app, or through Qobra’s public API. The table comes back with its full field schema, exactly as get_data_table returns it, so adding several columns in a row needs no read between them. A column synced from an integration, and a link to another data table, are set up on the table’s page in the Qobra web app instead, not here. Available only where the Qobra write tools beta is enabled. Every write is recorded in the audit trail as the Qobra MCP agent.

Parameters

Body

string
required
Id of the data table to add the column to — the id list_data_tables returns, or the one create_data_table just returned. Never a table name.
string
required
Display name of the column, as people will read it in Qobra — ‘Amount’, ‘Closing date’, ‘Owner’, ‘Stage’.
string
required
What the column holds. amount is monetary and percentage a ratio, where 0.15 reads as 15%; float is a plain number, for a count or a quantity. user holds a Qobra user, matched on their email when records are imported. picklist is one choice out of a fixed list and multipicklist several — both need options. A link to another data table is not created here. One of: float, amount, percentage, string, picklist, multipicklist, bool, date, user.
string
The column’s stable key: the identifier the public API and an Excel import address it by, distinct from the display name. Lowercase and underscore-separated, and unique within the table. Omit to derive it from the name (‘Closing date’ gives ‘closing_date’).
string[]
The labels people choose from, for a picklist or a multipicklist column — required there, and refused on every other type. These exact labels are what a record’s value is matched on when rows are imported.
string
For an amount column, the key of the column each row’s currency code is read from — a sibling field’s key on an imported table, a payload key on one fed through Qobra’s public API. Not a currency code itself, and refused on any other type. Omit it to denominate every row in the company currency.
string
Optional free-text note about what the column holds.

Response

Body

object
The data table the column was added to, with its full field schema as get_data_table returns it — the new column included. Read it to see the table as it now stands. See get_data_table for the field breakdown.
object
The column just created — which of data_table.fields is the new one, so its id is at hand without matching on a name.