Genaya

API Reference
SupportkeyGet API key
Core

Lead Tables

Lead table definitions (columns/schema). Read-only in v1.

GET/lead-tables

List lead tables

Returns an org-wide, cursor-paginated list of lead tables (the table schema documents that hold the columns each lead row is stored against). Soft-deleted tables are excluded. An API key sees EVERY table in the org - the per-creator/assignee privacy lockdown applied inside the app does NOT apply to API keys. Requires scope: leads:read.

Response 200

No fields.

Errors

400Malformed or missing parameters
401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
429Rate limited
500Unexpected server error
POST/lead-tables

Create a lead table

Creates a lead table. Requires scope: leads:write. Every table is created with the same two frozen system columns the app creates (First Name, Last Name), so a table made through the API behaves identically to one made in the UI. Additional columns may be declared with `columns`; each gets a stable `nameId` derived from its name, which is the key lead rows store their cells under. Multi-tab tables: pass `tabs` (mutually exclusive with `columns`) to create up to 20 tabs in one call. Only the first tab carries the system columns; later tabs start with just their own custom columns, exactly like tabs added in the app. Member assignment is not accepted here. An API key is an organization credential with no member identity, so tables it creates are visible org-wide - assign them in the app.

Request body

FieldTypeDescription
namerequired
string
The table's display name.
columns
array of object
Additional columns beyond the two system columns every table receives. Types needing extra configuration (select options, date format, currency, phone format) are created in their plain form - configure them in the app.
namerequired
string
Column label. A stable nameId is derived from it.
type
enumtext | long_text | number | date_time | phone | email | url | checkbox | single_select | multi_select

Response 201

FieldTypeDescription
idrequired
string
Unique identifier for the lead table.
objectrequired
string
The object type. Always "lead_table".
name
string
Human-readable name of the lead table.
createdBy
string
Id of the team member who created the table.nullable
assignedUserIds
array of string
Team member ids the table is shared with.
assignments
array of object
Resolved details for each assigned team member (id, email, name), as stored on the table at assign time.
id
string
Team member id.
email
string
Team member email.
name
string
Team member display name.
folderIds
array of string
Ids of the lead-table folders this table is filed under.
starred
boolean
Whether the table is marked as a favorite.
archived
boolean
Whether the table is archived (hidden from the default view).
archivedAt
string <date-time>
ISO-8601 timestamp of when the table was archived, or null.nullable
tabsrequired
array of object
The table's tabs (sub-sections), in storage order. Soft-deleted tabs are omitted.
idrequired
string
Stable identifier for the tab.
name
string
Display name of the tab.
displayOrder
integer
Ordering position of the tab within the table.
columnsrequired
array of object
The columns that make up this tab's schema, in definition order.
columnsrequired
array of object
Back-compat flattened list of every non-deleted column across every non-deleted tab, in tab-then-column order.
idrequired
string
Stable identifier for the column.
nameId
string
Stable key that lead rows store this column's value under. Survives renames.
namerequired
string
Display name of the column.
typerequired
string
The column data type (for example text, short_text, long_text, number, phone, email, date_time, single_select, multi_select, assignee, attachment, rating, checkbox).
collectionType
string
How the column was created - "system" for the built-in columns or "custom" for user-added ones.
visible
boolean
Whether the column is shown in the table.
frozen
boolean
Whether the column is pinned (frozen) to the left of the grid.
locked
boolean
Whether the column is locked against value edits.
hidden
boolean
Whether the column is hidden from the table view.
displayOrder
integer
Ordering position of the column within its tab.
options
array of object
Selectable options. Present only when type is single_select or multi_select.
dateTimeMode
string
Date/time granularity (date, time, or date_time). Present only when type is date_time.
dateTimeFormat
string
Display format string for the value. Present only when type is date_time.
numberPrecision
integer
Number of decimal places (0-4). Present only when type is number.
currencyEnabled
boolean
Whether the number is formatted as a currency. Present only when type is number.
currencyCode
string
ISO 4217 currency code when currency formatting is enabled. Present only when type is number.
currencyName
string
Human-readable currency name when currency formatting is enabled. Present only when type is number.
currencySymbol
string
Currency symbol when currency formatting is enabled. Present only when type is number.
phoneFormatEnabled
boolean
Whether phone-number formatting is applied. Present only when type is phone.
phoneAreaCode
string
Default dialing/area code when phone formatting is enabled. Present only when type is phone.
phoneFormat
string
Phone display format identifier when formatting is enabled. Present only when type is phone.
createdAt
string <date-time>
ISO-8601 timestamp of when the table was created.nullable
updatedAt
string <date-time>
ISO-8601 timestamp of when the table was last updated.nullable

Errors

400Malformed or missing parameters
401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
409Idempotency-Key reused with a different body
429Rate limited
500Unexpected server error
GET/lead-tables/{id}

Retrieve a lead table

Returns a single lead table (its tabs and column schema) by id. Returns 404 if the table is missing, soft-deleted, or belongs to another organization. Requires scope: leads:read.

Parameters

Path

idrequired
string
The id of the lead table.

Response 200

FieldTypeDescription
idrequired
string
Unique identifier for the lead table.
objectrequired
string
The object type. Always "lead_table".
name
string
Human-readable name of the lead table.
createdBy
string
Id of the team member who created the table.nullable
assignedUserIds
array of string
Team member ids the table is shared with.
assignments
array of object
Resolved details for each assigned team member (id, email, name), as stored on the table at assign time.
id
string
Team member id.
email
string
Team member email.
name
string
Team member display name.
folderIds
array of string
Ids of the lead-table folders this table is filed under.
starred
boolean
Whether the table is marked as a favorite.
archived
boolean
Whether the table is archived (hidden from the default view).
archivedAt
string <date-time>
ISO-8601 timestamp of when the table was archived, or null.nullable
tabsrequired
array of object
The table's tabs (sub-sections), in storage order. Soft-deleted tabs are omitted.
idrequired
string
Stable identifier for the tab.
name
string
Display name of the tab.
displayOrder
integer
Ordering position of the tab within the table.
columnsrequired
array of object
The columns that make up this tab's schema, in definition order.
columnsrequired
array of object
Back-compat flattened list of every non-deleted column across every non-deleted tab, in tab-then-column order.
idrequired
string
Stable identifier for the column.
nameId
string
Stable key that lead rows store this column's value under. Survives renames.
namerequired
string
Display name of the column.
typerequired
string
The column data type (for example text, short_text, long_text, number, phone, email, date_time, single_select, multi_select, assignee, attachment, rating, checkbox).
collectionType
string
How the column was created - "system" for the built-in columns or "custom" for user-added ones.
visible
boolean
Whether the column is shown in the table.
frozen
boolean
Whether the column is pinned (frozen) to the left of the grid.
locked
boolean
Whether the column is locked against value edits.
hidden
boolean
Whether the column is hidden from the table view.
displayOrder
integer
Ordering position of the column within its tab.
options
array of object
Selectable options. Present only when type is single_select or multi_select.
dateTimeMode
string
Date/time granularity (date, time, or date_time). Present only when type is date_time.
dateTimeFormat
string
Display format string for the value. Present only when type is date_time.
numberPrecision
integer
Number of decimal places (0-4). Present only when type is number.
currencyEnabled
boolean
Whether the number is formatted as a currency. Present only when type is number.
currencyCode
string
ISO 4217 currency code when currency formatting is enabled. Present only when type is number.
currencyName
string
Human-readable currency name when currency formatting is enabled. Present only when type is number.
currencySymbol
string
Currency symbol when currency formatting is enabled. Present only when type is number.
phoneFormatEnabled
boolean
Whether phone-number formatting is applied. Present only when type is phone.
phoneAreaCode
string
Default dialing/area code when phone formatting is enabled. Present only when type is phone.
phoneFormat
string
Phone display format identifier when formatting is enabled. Present only when type is phone.
createdAt
string <date-time>
ISO-8601 timestamp of when the table was created.nullable
updatedAt
string <date-time>
ISO-8601 timestamp of when the table was last updated.nullable

Errors

401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
404No such resource in this organization
429Rate limited
500Unexpected server error
PATCH/lead-tables/{id}

Rename a lead table

Renames a lead table. Requires scope: leads:write. `name` is the only writable field - archive/trash have their own endpoints and the schema is edited through the tab and column endpoints.

Request body

FieldTypeDescription
namerequired
string
The table's new display name.

Response 200

FieldTypeDescription
idrequired
string
Unique identifier for the lead table.
objectrequired
string
The object type. Always "lead_table".
name
string
Human-readable name of the lead table.
createdBy
string
Id of the team member who created the table.nullable
assignedUserIds
array of string
Team member ids the table is shared with.
assignments
array of object
Resolved details for each assigned team member (id, email, name), as stored on the table at assign time.
id
string
Team member id.
email
string
Team member email.
name
string
Team member display name.
folderIds
array of string
Ids of the lead-table folders this table is filed under.
starred
boolean
Whether the table is marked as a favorite.
archived
boolean
Whether the table is archived (hidden from the default view).
archivedAt
string <date-time>
ISO-8601 timestamp of when the table was archived, or null.nullable
tabsrequired
array of object
The table's tabs (sub-sections), in storage order. Soft-deleted tabs are omitted.
idrequired
string
Stable identifier for the tab.
name
string
Display name of the tab.
displayOrder
integer
Ordering position of the tab within the table.
columnsrequired
array of object
The columns that make up this tab's schema, in definition order.
columnsrequired
array of object
Back-compat flattened list of every non-deleted column across every non-deleted tab, in tab-then-column order.
idrequired
string
Stable identifier for the column.
nameId
string
Stable key that lead rows store this column's value under. Survives renames.
namerequired
string
Display name of the column.
typerequired
string
The column data type (for example text, short_text, long_text, number, phone, email, date_time, single_select, multi_select, assignee, attachment, rating, checkbox).
collectionType
string
How the column was created - "system" for the built-in columns or "custom" for user-added ones.
visible
boolean
Whether the column is shown in the table.
frozen
boolean
Whether the column is pinned (frozen) to the left of the grid.
locked
boolean
Whether the column is locked against value edits.
hidden
boolean
Whether the column is hidden from the table view.
displayOrder
integer
Ordering position of the column within its tab.
options
array of object
Selectable options. Present only when type is single_select or multi_select.
dateTimeMode
string
Date/time granularity (date, time, or date_time). Present only when type is date_time.
dateTimeFormat
string
Display format string for the value. Present only when type is date_time.
numberPrecision
integer
Number of decimal places (0-4). Present only when type is number.
currencyEnabled
boolean
Whether the number is formatted as a currency. Present only when type is number.
currencyCode
string
ISO 4217 currency code when currency formatting is enabled. Present only when type is number.
currencyName
string
Human-readable currency name when currency formatting is enabled. Present only when type is number.
currencySymbol
string
Currency symbol when currency formatting is enabled. Present only when type is number.
phoneFormatEnabled
boolean
Whether phone-number formatting is applied. Present only when type is phone.
phoneAreaCode
string
Default dialing/area code when phone formatting is enabled. Present only when type is phone.
phoneFormat
string
Phone display format identifier when formatting is enabled. Present only when type is phone.
createdAt
string <date-time>
ISO-8601 timestamp of when the table was created.nullable
updatedAt
string <date-time>
ISO-8601 timestamp of when the table was last updated.nullable

Errors

400Malformed or missing parameters
401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
404No such resource in this organization
429Rate limited
500Unexpected server error
DELETE/lead-tables/{id}

Move a lead table to trash

Moves a lead table to trash. Requires scope: leads:write. This is a soft delete. The lead rows inside are deliberately left intact - permanently destroying a table and every row under it is a confirmable, undoable-until-purged action that belongs in the app, not behind an API key.

Parameters

Path

idrequired
string

Response 200

FieldTypeDescription
id
string
object
string
deleted
boolean

Errors

401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
404No such resource in this organization
429Rate limited
500Unexpected server error
POST/lead-tables/{id}/tabs

Add a tab

Adds a tab to a lead table. Requires scope: leads:write. New tabs start with no system columns - only a table's first tab carries First/Last Name. Optional `columns` seeds custom columns. A table holds at most 20 live tabs.

Request body

FieldTypeDescription
name
string
Tab label. Defaults to "Tab N".
columns
array of object
Custom columns to seed the tab with - full LeadTableColumnCreate shape, including type-specific settings. New tabs carry no system columns - only a table's first tab has First/Last Name.
namerequired
string
Column label. A stable per-tab nameId is derived from it.
type
enumtext | long_text | number | date_time | phone | email | url | checkbox | single_select | multi_select
options
array of any
Select columns only. Options as strings or {name, color}; missing colors cycle the app's palette. Defaults to two seeded options.
dateTimeMode
enumdate | time | date_time
date_time columns only. Defaults to date.
dateTimeFormat
string
date_time columns only. Defaults MM/DD/YYYY (HH:mm for time).
numberPrecision
integer
number columns only. Decimal places, defaults 2.
currencyEnabled
boolean
number columns only.
currencyCode
string
number columns only. Defaults USD when enabled.
currencyName
string
number columns only.
currencySymbol
string
number columns only. Derived from the code when omitted.
phoneFormatEnabled
boolean
phone columns only.
phoneAreaCode
string
phone columns only. Defaults +1 when enabled.
phoneFormat
string
phone columns only. Defaults intl-dash when enabled.

Response 201

FieldTypeDescription
idrequired
string
Unique identifier for the lead table.
objectrequired
string
The object type. Always "lead_table".
name
string
Human-readable name of the lead table.
createdBy
string
Id of the team member who created the table.nullable
assignedUserIds
array of string
Team member ids the table is shared with.
assignments
array of object
Resolved details for each assigned team member (id, email, name), as stored on the table at assign time.
id
string
Team member id.
email
string
Team member email.
name
string
Team member display name.
folderIds
array of string
Ids of the lead-table folders this table is filed under.
starred
boolean
Whether the table is marked as a favorite.
archived
boolean
Whether the table is archived (hidden from the default view).
archivedAt
string <date-time>
ISO-8601 timestamp of when the table was archived, or null.nullable
tabsrequired
array of object
The table's tabs (sub-sections), in storage order. Soft-deleted tabs are omitted.
idrequired
string
Stable identifier for the tab.
name
string
Display name of the tab.
displayOrder
integer
Ordering position of the tab within the table.
columnsrequired
array of object
The columns that make up this tab's schema, in definition order.
columnsrequired
array of object
Back-compat flattened list of every non-deleted column across every non-deleted tab, in tab-then-column order.
idrequired
string
Stable identifier for the column.
nameId
string
Stable key that lead rows store this column's value under. Survives renames.
namerequired
string
Display name of the column.
typerequired
string
The column data type (for example text, short_text, long_text, number, phone, email, date_time, single_select, multi_select, assignee, attachment, rating, checkbox).
collectionType
string
How the column was created - "system" for the built-in columns or "custom" for user-added ones.
visible
boolean
Whether the column is shown in the table.
frozen
boolean
Whether the column is pinned (frozen) to the left of the grid.
locked
boolean
Whether the column is locked against value edits.
hidden
boolean
Whether the column is hidden from the table view.
displayOrder
integer
Ordering position of the column within its tab.
options
array of object
Selectable options. Present only when type is single_select or multi_select.
dateTimeMode
string
Date/time granularity (date, time, or date_time). Present only when type is date_time.
dateTimeFormat
string
Display format string for the value. Present only when type is date_time.
numberPrecision
integer
Number of decimal places (0-4). Present only when type is number.
currencyEnabled
boolean
Whether the number is formatted as a currency. Present only when type is number.
currencyCode
string
ISO 4217 currency code when currency formatting is enabled. Present only when type is number.
currencyName
string
Human-readable currency name when currency formatting is enabled. Present only when type is number.
currencySymbol
string
Currency symbol when currency formatting is enabled. Present only when type is number.
phoneFormatEnabled
boolean
Whether phone-number formatting is applied. Present only when type is phone.
phoneAreaCode
string
Default dialing/area code when phone formatting is enabled. Present only when type is phone.
phoneFormat
string
Phone display format identifier when formatting is enabled. Present only when type is phone.
createdAt
string <date-time>
ISO-8601 timestamp of when the table was created.nullable
updatedAt
string <date-time>
ISO-8601 timestamp of when the table was last updated.nullable

Errors

400Malformed or missing parameters
401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
404No such resource in this organization
429Rate limited
500Unexpected server error
PATCH/lead-tables/{id}/tabs/{tabId}

Rename a tab

Renames a tab. Requires scope: leads:write.

Parameters

Path

tabIdrequired
string

Request body

FieldTypeDescription
namerequired
string

Response 200

FieldTypeDescription
idrequired
string
Unique identifier for the lead table.
objectrequired
string
The object type. Always "lead_table".
name
string
Human-readable name of the lead table.
createdBy
string
Id of the team member who created the table.nullable
assignedUserIds
array of string
Team member ids the table is shared with.
assignments
array of object
Resolved details for each assigned team member (id, email, name), as stored on the table at assign time.
id
string
Team member id.
email
string
Team member email.
name
string
Team member display name.
folderIds
array of string
Ids of the lead-table folders this table is filed under.
starred
boolean
Whether the table is marked as a favorite.
archived
boolean
Whether the table is archived (hidden from the default view).
archivedAt
string <date-time>
ISO-8601 timestamp of when the table was archived, or null.nullable
tabsrequired
array of object
The table's tabs (sub-sections), in storage order. Soft-deleted tabs are omitted.
idrequired
string
Stable identifier for the tab.
name
string
Display name of the tab.
displayOrder
integer
Ordering position of the tab within the table.
columnsrequired
array of object
The columns that make up this tab's schema, in definition order.
columnsrequired
array of object
Back-compat flattened list of every non-deleted column across every non-deleted tab, in tab-then-column order.
idrequired
string
Stable identifier for the column.
nameId
string
Stable key that lead rows store this column's value under. Survives renames.
namerequired
string
Display name of the column.
typerequired
string
The column data type (for example text, short_text, long_text, number, phone, email, date_time, single_select, multi_select, assignee, attachment, rating, checkbox).
collectionType
string
How the column was created - "system" for the built-in columns or "custom" for user-added ones.
visible
boolean
Whether the column is shown in the table.
frozen
boolean
Whether the column is pinned (frozen) to the left of the grid.
locked
boolean
Whether the column is locked against value edits.
hidden
boolean
Whether the column is hidden from the table view.
displayOrder
integer
Ordering position of the column within its tab.
options
array of object
Selectable options. Present only when type is single_select or multi_select.
dateTimeMode
string
Date/time granularity (date, time, or date_time). Present only when type is date_time.
dateTimeFormat
string
Display format string for the value. Present only when type is date_time.
numberPrecision
integer
Number of decimal places (0-4). Present only when type is number.
currencyEnabled
boolean
Whether the number is formatted as a currency. Present only when type is number.
currencyCode
string
ISO 4217 currency code when currency formatting is enabled. Present only when type is number.
currencyName
string
Human-readable currency name when currency formatting is enabled. Present only when type is number.
currencySymbol
string
Currency symbol when currency formatting is enabled. Present only when type is number.
phoneFormatEnabled
boolean
Whether phone-number formatting is applied. Present only when type is phone.
phoneAreaCode
string
Default dialing/area code when phone formatting is enabled. Present only when type is phone.
phoneFormat
string
Phone display format identifier when formatting is enabled. Present only when type is phone.
createdAt
string <date-time>
ISO-8601 timestamp of when the table was created.nullable
updatedAt
string <date-time>
ISO-8601 timestamp of when the table was last updated.nullable

Errors

400Malformed or missing parameters
401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
404No such resource in this organization
429Rate limited
500Unexpected server error
DELETE/lead-tables/{id}/tabs/{tabId}

Delete a tab

Soft-deletes a tab. Requires scope: leads:write. The tab's lead rows are left untouched, and the last live tab cannot be deleted.

Parameters

Path

tabIdrequired
string

Response 200

FieldTypeDescription
id
string
object
string
deleted
boolean

Errors

400Malformed or missing parameters
401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
404No such resource in this organization
429Rate limited
500Unexpected server error
POST/lead-tables/{id}/tabs/{tabId}/columns

Add a column

Adds a custom column to a tab. Requires scope: leads:write. The column's stable `nameId` is derived from its name and is unique within the tab. Types needing extra configuration are created in plain form - configure them in the app.

Parameters

Path

tabIdrequired
string

Request body

FieldTypeDescription
namerequired
string
Column label. A stable per-tab nameId is derived from it.
type
enumtext | long_text | number | date_time | phone | email | url | checkbox | single_select | multi_select
options
array of any
Select columns only. Options as strings or {name, color}; missing colors cycle the app's palette. Defaults to two seeded options.
dateTimeMode
enumdate | time | date_time
date_time columns only. Defaults to date.
dateTimeFormat
string
date_time columns only. Defaults MM/DD/YYYY (HH:mm for time).
numberPrecision
integer
number columns only. Decimal places, defaults 2.
currencyEnabled
boolean
number columns only.
currencyCode
string
number columns only. Defaults USD when enabled.
currencyName
string
number columns only.
currencySymbol
string
number columns only. Derived from the code when omitted.
phoneFormatEnabled
boolean
phone columns only.
phoneAreaCode
string
phone columns only. Defaults +1 when enabled.
phoneFormat
string
phone columns only. Defaults intl-dash when enabled.

Response 201

FieldTypeDescription
idrequired
string
Unique identifier for the lead table.
objectrequired
string
The object type. Always "lead_table".
name
string
Human-readable name of the lead table.
createdBy
string
Id of the team member who created the table.nullable
assignedUserIds
array of string
Team member ids the table is shared with.
assignments
array of object
Resolved details for each assigned team member (id, email, name), as stored on the table at assign time.
id
string
Team member id.
email
string
Team member email.
name
string
Team member display name.
folderIds
array of string
Ids of the lead-table folders this table is filed under.
starred
boolean
Whether the table is marked as a favorite.
archived
boolean
Whether the table is archived (hidden from the default view).
archivedAt
string <date-time>
ISO-8601 timestamp of when the table was archived, or null.nullable
tabsrequired
array of object
The table's tabs (sub-sections), in storage order. Soft-deleted tabs are omitted.
idrequired
string
Stable identifier for the tab.
name
string
Display name of the tab.
displayOrder
integer
Ordering position of the tab within the table.
columnsrequired
array of object
The columns that make up this tab's schema, in definition order.
columnsrequired
array of object
Back-compat flattened list of every non-deleted column across every non-deleted tab, in tab-then-column order.
idrequired
string
Stable identifier for the column.
nameId
string
Stable key that lead rows store this column's value under. Survives renames.
namerequired
string
Display name of the column.
typerequired
string
The column data type (for example text, short_text, long_text, number, phone, email, date_time, single_select, multi_select, assignee, attachment, rating, checkbox).
collectionType
string
How the column was created - "system" for the built-in columns or "custom" for user-added ones.
visible
boolean
Whether the column is shown in the table.
frozen
boolean
Whether the column is pinned (frozen) to the left of the grid.
locked
boolean
Whether the column is locked against value edits.
hidden
boolean
Whether the column is hidden from the table view.
displayOrder
integer
Ordering position of the column within its tab.
options
array of object
Selectable options. Present only when type is single_select or multi_select.
dateTimeMode
string
Date/time granularity (date, time, or date_time). Present only when type is date_time.
dateTimeFormat
string
Display format string for the value. Present only when type is date_time.
numberPrecision
integer
Number of decimal places (0-4). Present only when type is number.
currencyEnabled
boolean
Whether the number is formatted as a currency. Present only when type is number.
currencyCode
string
ISO 4217 currency code when currency formatting is enabled. Present only when type is number.
currencyName
string
Human-readable currency name when currency formatting is enabled. Present only when type is number.
currencySymbol
string
Currency symbol when currency formatting is enabled. Present only when type is number.
phoneFormatEnabled
boolean
Whether phone-number formatting is applied. Present only when type is phone.
phoneAreaCode
string
Default dialing/area code when phone formatting is enabled. Present only when type is phone.
phoneFormat
string
Phone display format identifier when formatting is enabled. Present only when type is phone.
createdAt
string <date-time>
ISO-8601 timestamp of when the table was created.nullable
updatedAt
string <date-time>
ISO-8601 timestamp of when the table was last updated.nullable

Errors

400Malformed or missing parameters
401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
404No such resource in this organization
429Rate limited
500Unexpected server error
PATCH/lead-tables/{id}/tabs/{tabId}/columns/{columnId}

Edit a column

Renames a custom column and/or toggles its visibility. Requires scope: leads:write. The `nameId` never changes on rename - it is the stable key lead rows store cells under. System columns cannot be edited.

Parameters

Path

tabIdrequired
string
columnIdrequired
string

Request body

FieldTypeDescription
name
string
visible
boolean
options
array of object
Select columns only. Full replacement with id preservation.
id
string
Existing option id to keep. Omit for new options.
namerequired
string
color
string
displayOrder
integer
dateTimeMode
enumdate | time | date_time
dateTimeFormat
string
numberPrecision
integer
currencyEnabled
boolean
currencyCode
string
currencyName
string
currencySymbol
string
phoneFormatEnabled
boolean
phoneAreaCode
string
phoneFormat
string

Response 200

FieldTypeDescription
idrequired
string
Unique identifier for the lead table.
objectrequired
string
The object type. Always "lead_table".
name
string
Human-readable name of the lead table.
createdBy
string
Id of the team member who created the table.nullable
assignedUserIds
array of string
Team member ids the table is shared with.
assignments
array of object
Resolved details for each assigned team member (id, email, name), as stored on the table at assign time.
id
string
Team member id.
email
string
Team member email.
name
string
Team member display name.
folderIds
array of string
Ids of the lead-table folders this table is filed under.
starred
boolean
Whether the table is marked as a favorite.
archived
boolean
Whether the table is archived (hidden from the default view).
archivedAt
string <date-time>
ISO-8601 timestamp of when the table was archived, or null.nullable
tabsrequired
array of object
The table's tabs (sub-sections), in storage order. Soft-deleted tabs are omitted.
idrequired
string
Stable identifier for the tab.
name
string
Display name of the tab.
displayOrder
integer
Ordering position of the tab within the table.
columnsrequired
array of object
The columns that make up this tab's schema, in definition order.
columnsrequired
array of object
Back-compat flattened list of every non-deleted column across every non-deleted tab, in tab-then-column order.
idrequired
string
Stable identifier for the column.
nameId
string
Stable key that lead rows store this column's value under. Survives renames.
namerequired
string
Display name of the column.
typerequired
string
The column data type (for example text, short_text, long_text, number, phone, email, date_time, single_select, multi_select, assignee, attachment, rating, checkbox).
collectionType
string
How the column was created - "system" for the built-in columns or "custom" for user-added ones.
visible
boolean
Whether the column is shown in the table.
frozen
boolean
Whether the column is pinned (frozen) to the left of the grid.
locked
boolean
Whether the column is locked against value edits.
hidden
boolean
Whether the column is hidden from the table view.
displayOrder
integer
Ordering position of the column within its tab.
options
array of object
Selectable options. Present only when type is single_select or multi_select.
dateTimeMode
string
Date/time granularity (date, time, or date_time). Present only when type is date_time.
dateTimeFormat
string
Display format string for the value. Present only when type is date_time.
numberPrecision
integer
Number of decimal places (0-4). Present only when type is number.
currencyEnabled
boolean
Whether the number is formatted as a currency. Present only when type is number.
currencyCode
string
ISO 4217 currency code when currency formatting is enabled. Present only when type is number.
currencyName
string
Human-readable currency name when currency formatting is enabled. Present only when type is number.
currencySymbol
string
Currency symbol when currency formatting is enabled. Present only when type is number.
phoneFormatEnabled
boolean
Whether phone-number formatting is applied. Present only when type is phone.
phoneAreaCode
string
Default dialing/area code when phone formatting is enabled. Present only when type is phone.
phoneFormat
string
Phone display format identifier when formatting is enabled. Present only when type is phone.
createdAt
string <date-time>
ISO-8601 timestamp of when the table was created.nullable
updatedAt
string <date-time>
ISO-8601 timestamp of when the table was last updated.nullable

Errors

400Malformed or missing parameters
401Bad, missing, or revoked key
402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up
403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off
404No such resource in this organization
429Rate limited
500Unexpected server error