Sign in
Custom Fields

Create Custom Field

Create a new custom field.

post/api/v1/custom-fields

Request body

namestring required

Name of the custom field. Must be snake_case.

descriptionstring nullable

Description of the custom field.

category'HRIS' | 'ATS' | 'LMS' required
modelstring required

Model on which the custom field is to be applied.

Example request

{
  "name": "guardian_mobile",
  "description": "Employee's guardian mobile number",
  "model": "employee"
}

Response

Successful Response

object required

Changes