Create custom column
well_create_custom_columnCreate a new custom column on the current view in the workspace.
Use this tool when the user asks to add, create, or set up a new column on the active grid (e.g. "add an Industry column", "create an AI column that scores risk").
REQUIRED: name, type
type: one of text, number, amount, date, boolean, single_select, multi_select, record_reference, ai
a
record_referencecolumn also REQUIRES the root its values point at: one root inreference_target, or two or more inreference_targetswhen a cell may name records of several roots (for example people and companies). Send one of the two, never both. A column of people is how a person is held, so "an owner column" or "who handles it" is type=record_reference with reference_target=people. No other type takes a reference target. OPTIONAL: icon, rules_config, formula_config, format_config, reference_target, reference_targets, is_multipleis_multiple: for a
record_referencecolumn only. Pass true when one cell holds a list of records (for example "the people on this deal"); leave it out when a cell holds one record.
On a grid, the column is always created on the user's currently mounted
view: you do not (and cannot) choose a different one, and you do not ask
which view. With no grid (an assistant app, or a creation off-grid), pass
root: the view the user named, one of companies, people, invoices, transactions, account_balances, projects.
If the user named no view, ask which one before calling. If the user named
a table that is not in that list (for example products or tasks),
do not call this tool and never put the column on another table: say in one
line that this table cannot take a custom column yet, and name the tables
that can.
Naming: name must be unique within the current view. If a name conflict
is likely, ask the user to disambiguate before calling rather than retrying
after a failure response.
Position: the new column is auto-placed at the end of the view. You cannot set position via this tool.
Side effect: creating a column on a populated view automatically schedules an asynchronous recompute of all rows. You will not receive a tracking handle — values appear in the grid as workers finish.
Returns { success: true, custom_column_id, name, root, type } on success, or { success: false, error } on failure.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| icon | No | Optional Lucide icon name | |
| name | Yes | Column header label, unique within the same root (required) | |
| root | No | Target view root the column lands on: one of companies, people, invoices, transactions, account_balances, projects. OMIT when the user is on a grid — the mounted view is used and this is ignored. REQUIRED whenever no grid is mounted: a chart- or card-driven creation off-grid, and every call from an assistant app. | |
| type | Yes | Column data type — one of: text, number, amount, date, boolean, single_select, multi_select, record_reference, ai | |
| is_multiple | No | For a record_reference column only: true when one cell holds a list of records, false (the default) when it holds one | |
| rules_config | No | AI rules config (only for type=ai) | |
| workspace_id | No | Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several — a write lands in exactly one workspace and this call would not say which. | |
| format_config | No | Format config (currency, decimals, ...) | |
| formula_config | No | Formula config (only for computed columns) | |
| conversation_id | No | The conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation. | |
| idempotency_key | No | Optional client-supplied key. A retried write with the same key returns the original result instead of re-applying the operation. | |
| workspace_scope | No | Restrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace. | |
| reference_target | No | The root a record_reference column points at, one of: account_balances, accounts, activities, companies, documents, employment_contracts, invoices, journal_entries, journals, ledger_accounts, notes, payment_means, payslips, people, products, projects, subscriptions, tasks, transactions. Required for type=record_reference, refused for every other type. A column targeting people is a person column | |
| reference_targets | No | For a record_reference column whose cells may name records of several roots (a polymorphic link, for example people and companies): every root, two or more. Use in place of reference_target, never with it |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | ||
| name | No | ||
| root | No | ||
| type | No | ||
| error | No | ||
| success | Yes | ||
| reply_lines | No | ||
| conversation_id | No | The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation. | |
| near_candidates | No | ||
| newly_connected | No | Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later. | |
| custom_column_id | No | ||
| conversation_id_note | No | Present only when the server opened a fresh lane, stating that no choice recorded earlier was read. | |
| conversation_id_source | No | Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened. | |
| near_candidates_truncated | No |