API Reference
Become a partner

Create a new field.

post
https://api.hibob.com/v1/company/people/fields
Body Params

The field to be created.

string
required

The name of the field.

string
required

The category of the field.

string
required

The type of field. Supported field types: text, text-area, number, date, list, multi-list, hierarchy-list, currency, employee-reference, document.

string

The description of the field.

boolean
Defaults to false

When true, this field keeps the history of its values, each being active starting from a certain date. The default value is false.

Responses

400

If the category of the field is root, or historical is set to true, but the category doesn't allow it, or if the field type is not supported.

404

If the category of the field doesn't exist

Updated 9 months ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago