BAbamboohr
Custom Fields
Public API

Edit Custom Field

Changed on

Edit an existing custom field.

OAuth Scopes: employee:custom_fields.write

put/api/v1/hris/custom-fields/{customFieldId}

Request

Path parameters

customFieldIdstring required
Example:123

The ID of the custom field to edit.

Request body

idstring

The id of the Custom Field to be edited

namestring

The name of the Custom Field to be edited / created

typestring

The type of the Custom Field to be edited / created

tabinteger

The id of the tab where the Custom Field will be added

sectioninteger

The id of the section where the Custom Field will be added

requiredboolean

Whether the Custom Field is required or not

optionsstring[]

The options of the Custom Field to be edited / created

Response

Custom field edited.

idinteger

The id of the Custom Field

namestring

The name of the Custom Field

typestring

The type of the Custom Field

isEncryptedboolean

Whether the Custom Field is encrypted or not

isCalculatedboolean

Whether the Custom Field is calculated or not

isRequiredboolean

Whether the Custom Field is required or not

orderinteger

The order of the Custom Field

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

Changes