Employee Tables

Create a dependent entry for an employee

Changed on

Creates a new dependent entry for the employee. In the Bob UI this table may appear as <b>Children</b> or <b>Dependents</b>, depending on your company configuration. On success, returns the new entry id. Creating or deleting dependents also updates the employee's home.numberOfKids field (an employee field you can fetch with the <a href="https://apidocs.hibob.com/reference/post_people-search" target="_blank">People search</a> endpoint).<br /><br /> Required permissions: People's Data > People's fields > Home > Edit (or Children/Dependents table Edit).

post/people/{id}/dependents

Request

  • Base URL
    https://api.hibob.com/v1
  • URL
    https://api.hibob.com/v1/people/{id}/dependents
  • Auth
    • HTTP basic
    • or HTTP bearer

Path parameters

idstring required

Employee ID.

Request body

firstNamestring

Dependent's first name.

surnamestring

Dependent's surname / last name.

birthDatestring date

Dependent's date of birth (ISO 8601 date).

genderstring

Dependent's gender value as stored in Bob.

customColumnsobject

Custom column values for this entry, keyed by column id.

Response

Entry created successfully.

entryIdinteger required

The id of the newly created dependents table entry.

Changes