Create a dependent entry for an employee

Creates a new dependent entry for the employee. In the Bob UI this table may appear as Children or Dependents, 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 People search endpoint).

Required permissions: People's Data > Home > Manage selected employees' Home sections (or Children/Dependents table Manage when field-level permissions are enabled).

Path Params
string
required

Employee ID.

Body Params

Values for the dependent entry you want to add.

Request body for creating a dependent entry. Do not send id; the system assigns it on create.

string

Dependent's first name.

string

Dependent's surname / last name.

date

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

string

Dependent's gender value as stored in Bob.

Response

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