Skip to main content
PATCH
Update a table's account source

Authorizations

X-API-Key
string
header
required

Path Parameters

table_id
string<uuid>
required

Body

application/json

What a person sets for one table on the Accounts page; a field left out stays as it is.

company_column_id

The column that names each row's company, chosen by hand; null goes back to the column the table's own columns point to.

manager_column_id

The column holding each person's manager (a name, address or profile); null reads no manager column.

show_on_accounts

Whether the table feeds Accounts.

Response

Successful Response

One table's standing on the Accounts page, and why.

account_count
integer
required

The accounts its rows sit on, at the last index.

awaits_index
boolean
required

Whether an index of the table is on its way: it was looked at and is not indexed yet, in a workspace whose Accounts were opened. Its counts arrive when this turns false; false in a workspace that never opened Accounts, where nothing indexes it.

candidates
AccountSourceCandidateReadSchema · object[]
required

The columns a person may choose as the company column: the two that disagree when two website columns do, otherwise the one chosen, the columns that read as a website, a company LinkedIn page or a work email, then every other text, link or address column that is not a name, a profile, a manager or a company fact such as Industry.

columns
AccountSourceColumnReadSchema · object[]
required

The columns its rows are read through, and why each.

company_column_id
string<uuid> | null
required
indexed_at
string<date-time> | null
required

When it was last indexed; None before then.

left_off
AccountLeftOffReadSchema · object[]
required

Its rows on no account at the last index, by what they lack (company_name_only: a company name but no website, company page or work address; personal_email: only a personal address such as Gmail; no_company: nothing that names a company), each with the first such row; its rows number row_count plus these. Empty before an index counted them.

manager_candidates
AccountSourceCandidateReadSchema · object[]
required

Columns that may hold each person's manager, by their label, for a person to pick as the manager column.

manager_column_id
string<uuid> | null
required
manager_options
AccountSourceCandidateReadSchema · object[]
required

Every column a person may pick as a people table's manager column: the suggested ones first, then each other column that could name a person (never the row's own name, title, profile, address or company, a website, a company fact, the Person researcher's or a column a sequence or an export writes), and the one chosen. A company table offers only the one chosen.

reason
enum<string> | null
required

Why the table is not linked, if not.

Available options:
no_company_column,
two_company_columns,
turned_off
row_count
integer
required

Its rows on an account, at the last index.

row_kind
enum<string>
required

What one row of a linked table stands for on an account: the company, or a person there.

Available options:
company,
person
show_on_accounts
boolean
required
status
enum<string>
required

Whether a table's rows feed the Accounts page.

Available options:
linked,
not_linked
table_id
string<uuid>
required
table_name
string
required
sole_account_key
string | null

The one account its rows are on, when account_count is 1; read by GET /accounts/sources/{table_id}/ alone, null in the list.