API Reference

Create HR Custom Field

post
https://api.worklio.com/wep/companies//hr-fields

Create HR Custom Field.

This endpoint can be called only by System and Admin and ClientAdmin level users.

Employee call will return Forbidden result even for Employee own company.

Path Params
int32
required
Body Params
int32
enum
required

Members:

  • 1 - Text ( Text. )
  • 2 - MultilineText ( Multiline text )
  • 3 - SingleSelect ( Single Select )
  • 4 - MultiSelect ( Multi Select )
  • 5 - Date ( Date )
  • 6 - Checkbox ( Checkbox )
  • 7 - Currency ( Currency )
  • 8 - Number ( Number )
  • 9 - SingleSelectValue ( Single Select Value )
  • 10 - MultiSelectValue ( Multi Select Value )
string | null
required

Label

string | null

Hint

string | null

Placeholder

boolean | null
required

Is Required

validations
array of objects | null

Validation

validations
selectOptions
array of strings | null

Select Options - dropdown Data type is validated and is required if type property is set to 4 or 3.

selectOptions
selectOPtionsExt
array of objects | null

Select Options Ex - dropdown with values Data type is validated and is required if type property is set to 10 or 9.

selectOPtionsExt
int32
enum
required

Members:

  • 0 - None ( User doesn't have any access on value of custom field. Custom field is invisible to user. )
  • 1 - Read ( User can read value from custom field. )
  • 2 - Write ( User can write value to custom field. )
Allowed:
Headers
string
Defaults to 1.0

The requested API version

string
Defaults to 1.0

The requested API version

Responses

Updated 7 months ago

Language
Credentials
Bearer
jwt
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago