Delete Custom Table Field
Changed onDeletes a single column from a custom table, including all data stored in it, and removes the field from any custom reports that reference it. This cannot be undone. Requires the acting user to be an owner-admin. Use this to remove one column; a 404 is returned when the table does not exist, when the field does not exist, or when the field exists but belongs to a different table, so repeating a delete returns 404 rather than succeeding. To replace the table's entire column set in a single request, use Update Custom Table (update-public-custom-table) instead. For a standalone field not backed by a table, use Custom Fields > Archive Custom Field (archive-public-custom-field) instead, which soft-archives the field rather than permanently deleting it.
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 delete a field from.
The ID of the custom table field to delete.
Response
Custom table field deleted.
Changes
- info
endpoint added
- info