Custom Tables
Public API

Update Custom Table

Changed on

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

put/api/v1/hris/custom-tables/{customTableId}

Request

Path parameters

customTableIdstring required
Example:123

The ID of the custom table to edit.

Request body

idinteger

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).

namestring required

The name of the Custom Table to be edited / created

type'grid' | 'history' required

The type of the Custom Table to be edited / created

sortOrderDirection'asc' | 'desc'

The sort order direction of the Custom Table

allowEditsboolean

Whether the Custom Table allows edits or not

Response

The updated custom table object.

idinteger

The id of the Custom Table

namestring

The name of the Custom Table

typestring

The type of the Custom Table

isEncryptedboolean

Whether the Custom Table is encrypted or not

isCalculatedboolean

Whether the Custom Table is calculated or not

isRequiredboolean

Whether the Custom Table is required or not

orderinteger

The order of the Custom Table

summarize'none' | 'total' | 'average'

The aggregation applied when computing totals for this field. Only meaningful for custom table columns; always "none" for standalone custom fields and for the custom table object itself.

valuesstring[]

The values of the Custom Field

sortOrderDirectionstring

The sort order direction of the Custom Table

Changes