Skip to main content
POST
Create Custom Field

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Name of the custom field. Must be snake_case.

Required string length: 2 - 128
Example:

"guardian_mobile"

category
enum<string>
required

Category of the model on which the custom field is created.

Available options:
HRIS,
ATS,
LMS
Example:

"HRIS"

model
string
required

Model on which the custom field is to be applied.

Maximum string length: 64
Pattern: ^[a-z][a-z0-9_-]*$
Example:

"employee"

description
string | null

Description of the custom field.

Example:

"Employee's guardian mobile number"

Response

Successful Response

The response is of type Response Create Custom Field Api V1 Custom Fields Post · object.