Promote an enrichment output field into its own column

curl --request POST \
  --url https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/promote-field/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "field_name": "<string>",
  "confirm_overwrite": false,
  "display_name": "<string>",
  "target_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/promote-field/"

payload = {
    "field_name": "<string>",
    "confirm_overwrite": False,
    "display_name": "<string>",
    "target_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    field_name: '<string>',
    confirm_overwrite: false,
    display_name: '<string>',
    target_column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/promote-field/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/promote-field/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'field_name' => '<string>',
    'confirm_overwrite' => false,
    'display_name' => '<string>',
    'target_column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/promote-field/"

	payload := strings.NewReader("{\n  \"field_name\": \"<string>\",\n  \"confirm_overwrite\": false,\n  \"display_name\": \"<string>\",\n  \"target_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/promote-field/")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"field_name\": \"<string>\",\n  \"confirm_overwrite\": false,\n  \"display_name\": \"<string>\",\n  \"target_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/promote-field/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"field_name\": \"<string>\",\n  \"confirm_overwrite\": false,\n  \"display_name\": \"<string>\",\n  \"target_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "column_type": "text",
  "created_at": "2023-11-07T05:31:56Z",
  "data_type": "string",
  "definition": {
    "default_value": "<string>",
    "kind": "manual"
  },
  "definition_version": 123,
  "depends_on_column_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "description": "<string>",
  "display_name": "<string>",
  "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_group_output": true,
  "kind": "manual",
  "position": 123,
  "supported_filter_operators": [
    "eq"
  ],
  "table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type_options": {
    "choices": [
      {
        "value": "<string>",
        "color": "<string>"
      }
    ],
    "type": "select"
  },
  "updated_at": "2023-11-07T05:31:56Z",
  "ai_made": false,
  "auto_run": true,
  "pending_recompute": false,
  "refresh_interval_hours": 0,
  "run_condition": {
    "default_value": "<string>",
    "kind": "manual"
  },
  "run_condition_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "run_condition_view_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "run_delay_seconds": 0
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "issues": [
    {
      "input": "<string>",
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

table-columns

Promote an enrichment output field into its own column

Create a formula column that reads one declared output field out of a multi-field enrichment’s payload. The child is typed by the field’s declared type, dependency-linked to its parent, free to recompute, and immediately backfilled by its column-added run. With target_column_id, the field’s current values instead overwrite an existing manual column. Destructive, and refused without confirm_overwrite.

POST

tables

{table_id}

columns

{column_id}

promote-field

Promote an enrichment output field into its own column

curl --request POST \
  --url https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/promote-field/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "field_name": "<string>",
  "confirm_overwrite": false,
  "display_name": "<string>",
  "target_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/promote-field/"

payload = {
    "field_name": "<string>",
    "confirm_overwrite": False,
    "display_name": "<string>",
    "target_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    field_name: '<string>',
    confirm_overwrite: false,
    display_name: '<string>',
    target_column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/promote-field/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/promote-field/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'field_name' => '<string>',
    'confirm_overwrite' => false,
    'display_name' => '<string>',
    'target_column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/promote-field/"

	payload := strings.NewReader("{\n  \"field_name\": \"<string>\",\n  \"confirm_overwrite\": false,\n  \"display_name\": \"<string>\",\n  \"target_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/promote-field/")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"field_name\": \"<string>\",\n  \"confirm_overwrite\": false,\n  \"display_name\": \"<string>\",\n  \"target_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoneprofile.ai/tables/{table_id}/columns/{column_id}/promote-field/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"field_name\": \"<string>\",\n  \"confirm_overwrite\": false,\n  \"display_name\": \"<string>\",\n  \"target_column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "column_type": "text",
  "created_at": "2023-11-07T05:31:56Z",
  "data_type": "string",
  "definition": {
    "default_value": "<string>",
    "kind": "manual"
  },
  "definition_version": 123,
  "depends_on_column_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "description": "<string>",
  "display_name": "<string>",
  "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_group_output": true,
  "kind": "manual",
  "position": 123,
  "supported_filter_operators": [
    "eq"
  ],
  "table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type_options": {
    "choices": [
      {
        "value": "<string>",
        "color": "<string>"
      }
    ],
    "type": "select"
  },
  "updated_at": "2023-11-07T05:31:56Z",
  "ai_made": false,
  "auto_run": true,
  "pending_recompute": false,
  "refresh_interval_hours": 0,
  "run_condition": {
    "default_value": "<string>",
    "kind": "manual"
  },
  "run_condition_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "run_condition_view_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "run_delay_seconds": 0
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "issues": [
    {
      "input": "<string>",
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

X-API-Key

string

header

required

Path Parameters

table_id

string<uuid>

required

column_id

string<uuid>

required

Body

application/json

Promote one declared output field of an enrichment into its own column.

field_name

string

required

The declared output field to promote.

Required string length: 1 - 100

confirm_overwrite

boolean

default:false

Explicit acknowledgement that mapping to an existing column overwrites what that column holds. Required with target_column_id.

display_name

string | null

The child column's name; the field's name when omitted.

Required string length: 1 - 255

target_column_id

string<uuid> | null

Map onto this EXISTING manual column instead of creating one. The field's current values overwrite everything the column holds. Destructive; requires confirm_overwrite.

Response

Successful Response

A table column with its definition and dependency metadata.

column_type

enum<string>

required

The semantic type; what the cell renders and validates as.

Available options:

text,

paragraph,

url,

email,

image_url,

person,

select,

number,

decimal,

currency,

checkbox,

date,

multi_select,

list,

object

created_at

string<date-time>

required

data_type

enum<string>

required

The storage type column_type resolves to, and so which typed value slot the cells live in. Derived, never chosen.

Available options:

string,

integer,

float,

boolean,

datetime,

date,

list,

dict

definition

ManualColumnDefinition · object

required

Definition of a manual column: typed, user-editable cells.

Show child attributes

definition_version

integer

required

Bumped on definition changes; cosmetic edits leave it untouched.

depends_on_column_ids

string<uuid>[]

required

Direct chain inputs; empty for manual columns.

description

string | null

required

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

display_name

string

required

group_id

string<uuid> | null

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.

string<uuid>

required

is_group_output

boolean

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

enum<string>

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.

Available options:

manual,

formula,

enrichment,

source,

export,

sequence

position

integer

required

supported_filter_operators

enum<string>[]

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.

A row filter predicate.

Which operators are legal depends on the column's data type; the service validates the pairing and rejects a mismatch, so an operator here is a vocabulary entry rather than a promise it applies everywhere.

Two families live here. The VALUE operators ask about what a cell holds and are keyed off the column's storage slot. The STATE operators ask about what the last run DID to the cell (errored, skipped, never ran, went stale) and are keyed off the column's kind instead: they read the compute metadata that only a computed column ever writes, and mean nothing on a hand-typed one.

Available options:

eq,

neq,

gt,

gte,

lt,

lte,

contains,

not_contains,

contains_any_of,

not_contains_any_of,

starts_with,

is_true,

is_false,

is_empty,

is_not_empty,

has_error,

has_no_error,

has_results,

has_no_results,

has_not_run,

is_stale,

is_not_stale,

run_condition_not_met,

run_stopped

table_id

string<uuid>

required

type_options

SelectOptions · object

required

Per-type options; null means the type's defaults.

SelectOptions
MultiSelectOptions
CurrencyOptions
DecimalOptions

Show child attributes

updated_at

string<date-time>

required

ai_made

boolean

default:false

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_run

boolean

default:true

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

pending_recompute

boolean

default:false

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.

refresh_interval_hours

integer

default:0

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

run_condition

ManualColumnDefinition · object

The per-row gate, verbatim; null runs every row.

Show child attributes

run_condition_group_id

string<uuid> | null

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_id

string<uuid> | null

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_seconds

integer

default:0

Pre-run wait in seconds; 0 runs immediately.

API reference

Endpoints

Promote an enrichment output field into its own column

Authorizations

Path Parameters

Body

Response