Custom Tables
Public API

Delete Custom Table Field

Changed on

Deletes 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

delete/api/v1/hris/custom-tables/{customTableId}/fields/{fieldId}

Request

Path parameters

customTableIdstring required
Example:123

The ID of the custom table to delete a field from.

fieldIdstring required
Example:456

The ID of the custom table field to delete.

Response

Custom table field deleted.

Changes