Update Custom Field
Update a custom field’s name or description. category and model can only be changed while the field has no mappings.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
Name of the custom field. Must be snake_case.
2 - 128"guardian_mobile"
Description of the custom field. Send null to clear it.
"Employee's guardian mobile number"
Category of the model on which the custom field is created. Cannot be changed once the field has mappings.
HRIS, ATS, LMS "HRIS"
Model on which the custom field is to be applied. Cannot be changed once the field has mappings.
64^[a-z][a-z0-9_-]*$"employee"
Response
Successful Response
Unique identifier of the custom field.
"018e586b-7d0b-7bc9-be65-a8fdbc82d734"
Name of the custom field (snake_case).
"guardian_mobile"
Category of the model.
HRIS, ATS, LMS "HRIS"
Model on which the custom field is applied.
"employee"
Origin of the custom field. 'API' if created through the public API, 'DASHBOARD' if created from the Bindbee dashboard.
DASHBOARD, API "API"
Counts of mappings for this custom field, broken down by scope.
Description of the custom field.
"Employee's guardian mobile number"
All mappings configured for this custom field.