table-columns

Update a table column

Partially update a column (omitted fields are left untouched). The kind is immutable. A formula definition change requests a column-edited recompute run. It appears on the next active-runs poll; the response carries only the requires_recompute flag, never a run ID. Cosmetic edits and manual default_value edits request nothing. A type change that stores values differently converts every value it can; cleared_count is how many it could not convert and left blank, which the retype preview forecasts beforehand.

patch/tables/{table_id}/columns/{column_id}/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

table_idstring uuid required
column_idstring uuid required

Request body

expand_output_fieldsboolean

For a multi-field enrichment, keep the fan-out in step with the declared output: create one child column per scalar output field this edit ADDS (the same fan-out a column of the same shape gets when it is created), and DELETE the column of a field it REMOVES, along with that column's values. A removed field's column reads a key the answer no longer carries, so it could only ever sit empty. A field the column already declared is left alone, and a column another column depends on is kept rather than breaking it. Set false to change the output without touching any other column.

output_column_namesobject

What to CALL each child column this edit ADDS, keyed by output field name (the create request's field, read the same way). Without it a new child's header is derived from the field's key, which reads a hand-written name back as though it were one: a field called 'LinkedIn URL' becomes the column 'Linked In Url'. A field with no entry keeps the derived name, a name already taken on the table falls back to the derived one rather than losing the column, and a field this edit did not add is ignored. Ignored when expand_output_fields is false. Children that already exist are never renamed.

suppress_runboolean

Save the change without recomputing. The column's cells keep their current values and pending_recompute is set, so the staleness is recorded rather than hidden; run the column when you are ready. A plain bool, not tri-state: it instructs THIS request and has no 'leave unchanged' meaning to carry over.

Response

Successful Response

ai_madeboolean

Whether the AI assistant created this column through a workspace action. A fact about who made it, not a state: it stays true after a person edits the column.

auto_runboolean

Whether data changes recompute this column by themselves; explicit runs ignore it.

cleared_countinteger required

Values a type change could not convert into the new type and left blank; 0 when no value moved.

column_type'text' | 'paragraph' | 'url' | 'email' | 'image_url' | 'person' | 'select' | 'number' | 'decimal' | 'currency' | 'checkbox' | 'date' | 'multi_select' | 'list' | 'object' required

The type a user picks for a table column.

Ordered as the picker shows them, which is also the order the groups below run in: text-ish, then numeric, then choice, then structured.

created_atstring date-time required
data_type'string' | 'integer' | 'float' | 'boolean' | 'datetime' | 'date' | 'list' | 'dict' required

Type of a property. Used while creating/updating/deleting properties.

definition_versioninteger required

Bumped on definition changes; cosmetic edits leave it untouched.

depends_on_column_idsstring[] required

Direct chain inputs; empty for manual columns.

descriptionstring nullable required

Author-written note on what the column holds; null when unset.

display_namestring required
group_idstring uuid nullable required

The column group this column belongs to, or null. Groups are user-managed entities delivered on the column list's groups; this field is the membership edge, and the members' order is simply the columns' position order.

idstring uuid required
is_group_outputboolean required

Whether this member stays visible while its group is collapsed. Meaningful only while group_id is set. Every group keeps at least one output.

kind'manual' | 'formula' | 'enrichment' | 'source' | 'export' | 'sequence' required

Kind of a table column.

MANUAL cells are user-editable; FORMULA cells are a pure computed chain over other columns; ENRICHMENT cells are produced by an external action (an AI model, a research agent) run once per row. Formula and enrichment cells are both computed (read-only in the grid) but only enrichment work leaves the process and costs credits.

SOURCE cells hold one imported record verbatim, written only by the table's import source. Like MANUAL it is an externally-written leaf rather than a computed node (it joins no run plan and derives from no other column), but unlike MANUAL nobody may edit or retype it: the whole point is that a refresh can overwrite it wholesale, and every get_path column promoted off it reads paths that only survive while its shape does.

EXPORT cells hold the RECEIPT of pushing the row to a connected destination (status, the destination record id, when it happened), never the row's own data. The mirror image of SOURCE: where a source column is an externally-written leaf, an export column is an externally-READ leaf. It joins the run plan like a computed column (its mappings are dependencies, so a changed input re-pushes) but nothing may depend on it in turn, nobody may edit it (a hand-edited receipt would silently pin the row out of future pushes), and re-running it means "push again", not "re-answer".

SEQUENCE cells hold a contact's live status in an email sequence, or the messages it sent them, written by the outreach send engine and nobody else: an externally-written leaf with no run plan, no dependencies, no user edits, no retyping. A status column, like EXPORT receipts, may not be referenced in a formula: the status only exists to be looked at, never derived from. A messages column may, the way a SOURCE record may: the engine requests a run of its dependents whenever it rewrites a cell. The columns are created by the sequence that targets the table, not from the add-column catalog.

pending_recomputeboolean

The definition has changed since these cells were last computed, so they are stale. Set by a save made with suppress_run, cleared when the column next finishes a run.

positioninteger required
refresh_interval_hoursinteger

Self re-run cadence in hours; 0 is off.

requires_recomputeboolean required

Whether the update marked the column for recompute. The run itself arrives via the active-runs poll, never in this response.

run_condition_group_idstring uuid nullable

When set, run_condition is inherited from this column group and is rewritten whenever the group's changes. Set a run_condition on the column to override it, or clear the column's to inherit again.

run_condition_view_idstring uuid nullable

When set, the column follows this saved view's filter as its run condition. The engine evaluates view membership at run time rather than reading run_condition. Editing the run condition directly detaches from the view.

run_delay_secondsinteger

Pre-run wait in seconds; 0 runs immediately.

supported_filter_operatorsTableFilterOperator[] required

Every filter operator this column admits, in display order. The server owns the list so a picker cannot offer a pairing the rows query will reject: value operators follow the storage slot, and a computed column additionally admits the execution-state family (has an error, has results, has not run, is stale, ...), which reads run metadata a manual column never writes.

table_idstring uuid required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.