Update Custom Table

Updates an existing custom table's metadata and, optionally, replaces its full set of columns. Requires the acting user to be an owner-admin. The tab value is the target tab's page ID; use Custom Fields > List Custom Fields (list-custom-fields) to find the pageId of an existing field on the desired tab — changing tab moves the table to that page. Any id in the request body is ignored; the table edited is always the one identified by the path. Omitted optional fields reset rather than persist: leaving out allowEdits resets it to true, and leaving out sortOrderDirection resets it to desc. Omitting columns leaves existing columns unchanged; including columns replaces the entire column set, deleting any existing column whose id is not present in the array — include a column's id to update it in place, or omit id to add a new column. To add a single column without resending the rest, use Create Custom Table Field (create-public-custom-table-field) instead; to delete a single column without resending the rest, use Delete Custom Table Field (delete-public-custom-table-field) instead; to reorder columns without resending field definitions, use Reorder Custom Table Fields (reorder-public-custom-table-fields) instead. A request that changes nothing returns the table unchanged rather than an error.

OAuth Scopes: employee:custom_fields.write

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[1-9]\d*$

The ID of the custom table to edit.

Body Params

For editing a table, columns is optional; when provided, it replaces the table's entire column set.

integer

The id of the Custom Table. Ignored on write: the table id always comes from the path (edit) or is assigned by the server (create).

string
required

The name of the Custom Table to be edited / created

string
enum
required

The type of the Custom Table to be edited / created

Allowed:
required
≥ 1

The id of the tab where the Custom Table will be added or moved. Accepts either the integer or numeric-string form of a page id, such as the pageId returned by List Custom Fields.

string
enum

The sort order direction of the Custom Table

Allowed:
boolean

Whether the Custom Table allows edits or not

columns
array of objects

The columns of the Custom Table to be edited / created

columns
Responses

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json