HIhibob
Metadata

Create a new field.

Changed on
post/company/people/fields

Request

  • Base URL
    https://api.hibob.com/v1
  • URL
    https://api.hibob.com/v1/company/people/fields
  • Auth
    • HTTP basic
    • or HTTP bearer

Request body

namestring required

The name of the field.

categorystring required

The category of the field.

typestring required

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

descriptionstring

The description of the field.

historicalboolean

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

Response

The new field was successfully created. The ID of the field is returned.

idstring

The ID of the field.

Changes