BIbindbee
Custom Fields

Create Custom Field

Changed on

Create a new custom field.

post/api/v1/custom-fields

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

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

idstring uuid required
statusstring required

Changes

  • 572789b789f4Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • eb3486b88e55Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status