Update Custom Table
Changed onUpdates 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
Request
- Base URLhttps://companySubDomain.bamboohr.com
- AuthOAuth 2Authorization code/authorize.phpToken URL/token.phpScopesemployee:custom_fields.write
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The ID of the custom table to edit.
Request body
Response
The updated custom table object.
Changes
- info
endpoint added
- info