---
title: "Update the home section for a given employee id."
method: PUT
path: "/employees/{employeeId}/homes"
tags: ["Employees"]
---

# Update the home section for a given employee id.

`PUT /employees/{employeeId}/homes`

This endpoint updates the employee **home** section for a given employee id. The operation only updates the fields provided in the body.
<br><br>**Custom fields** information can be provided in this operation. The *API name* of the custom field is required and the data format has to match with the type defined for the custom field in Kenjo.
API names start with 'c_' and the rest is composed by the trimmed name (spaces are removed).
<br><br>
Example:
<br>
*The custom field 'pet name' belongs to the 'home' section*:
  ```
  {
    ...,
    "maritalStatus": "Divorced",
    "c_petname": "Boliche",
    ...
  }
```
*'pet name' is a field type 'String'. It means that if a different type of data (number or boolean) is provided then the request will return an error.*

## Path parameters

- `employeeId` string, required

## Headers

- `Authorization` string, required

## Request body

- object
  - `maritalStatus` string — The marital status. Only is valid one of the following values "Divorced", "Domestic Partnership", "Married", "Separated", "Single", "Widowed".
  - `spouseFirstName` string — The first name of the employee's spouse.
  - `spouseLastName` string — The last name of the employee's spouse.
  - `spouseBirthdate` string — The birth date of the employee's spouse. Format YYYY-MM-DDThh:mm:ss.000Z.
  - `spouseGender` string — The employee's spouse gender. Only is valid one of the following values 'Male' (male), 'Female' (female) or 'Other' (other).
  - `personalEmail` string — The employee personal email.
  - `personalPhone` string — The employee personal phone.
  - `personalMobile` string — The employee personal phone
  - `children` unknown[] — The employee children.
    - unknown

## Response `200`

OK

- object
  - `_id` string — The employee Kenjo *_id*.
  - `maritalStatus` string — The marital status. Only is valid one of the following values "Divorced", "Domestic Partnership", "Married", "Separated", "Single", "Widowed".
  - `spouseFirstName` string — The first name of the employee's spouse.
  - `spouseLastName` string — The last name of the employee's spouse.
  - `spouseBirthdate` string — The birth date of the employee's spouse. Format YYYY-MM-DDThh:mm:ss.000Z.
  - `spouseGender` string — The employee's spouse gender. Only is valid one of the following values 'Male' (male), 'Female' (female) or 'Other' (other).
  - `personalEmail` string — The employee personal email.
  - `personalPhone` string — The employee personal phone.
  - `personalMobile` string — The employee personal phone
  - `children` unknown[] — The employee children.
    - unknown

## Other responses

- `400` — BAD REQUEST. This is a wrong request in the client side due to invalid body or params.
- `401` — UNAUTHORIZED. The Authorization header is incorrect, not provided or the token expired.

---

[API](https://skmtc.net/kenjo/apis/kenjo-api.md) · [All operations](https://skmtc.net/kenjo/apis/kenjo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kenjo/kenjo-api/revisions/58772b78268e/schema)