Employees

Update the home section for a given employee id.

This endpoint updates the employee home section for a given employee id. The operation only updates the fields provided in the body. 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). Example: 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.

put/employees/{employeeId}/homes

Request

Base URL
https://sandbox-api.kenjo.io/api/v1
Auth
none declared. Required headers: Authorization
TypeScript
https://skmtc.dev/kenjo/apis/kenjo-api/docs/employees/:employeeId/homes/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

employeeIdstring required

Example:60a2db290da29e126a18789a

The _id of the employee to update.

Headers

Authorizationstring required

Example:Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5rZW5qby5pbyIsInN1YiI6IjYwZjBhOTE2MjE0OTg3MjU2YmU5YzhmZiIsImF1ZCI6Imh0dHBzOi8vYXBpLmtlbmpvLmlvIiwiaWF0IjoxNjI2Mzg1MTE1LCJuYmYiOjE2MjYzODUxMTUsImV4cCI6MTYyNjU1NzkxNSwiYWNjZXNzVHlwZSI6IkFwaUFjY2VzcyIsInNfb3JnSWQiOiI2MGYwNGVhN2RmN2JhMjFlY2U0YmYzYzIifQ.cxG_7dIS-VbmDXdJuLkekoyuyCIzQG2fMcgc0nkfbWE8cihhcb5FnALbQkjU9b5-qVcEoMHZlSuUA-jMEBMMVQ

A valid bearer token.

Request body

maritalStatusstring

The marital status. Only is valid one of the following values "Divorced", "Domestic Partnership", "Married", "Separated", "Single", "Widowed".

spouseFirstNamestring

The first name of the employee's spouse.

spouseLastNamestring

The last name of the employee's spouse.

spouseBirthdatestring

The birth date of the employee's spouse. Format YYYY-MM-DDThh:mm:ss.000Z.

spouseGenderstring

The employee's spouse gender. Only is valid one of the following values 'Male' (male), 'Female' (female) or 'Other' (other).

personalEmailstring

The employee personal email.

personalPhonestring

The employee personal phone.

personalMobilestring

The employee personal phone

Example request

{
  "maritalStatus": "Widowed",
  "spouseFirstName": "Catherine",
  "spouseLastName": "Tramell",
  "spouseBirthdate": "2060-01-26T00:00:00.000Z",
  "spouseGender": "Female",
  "personalEmail": "john@acme.io",
  "personalPhone": "4567092323",
  "personalMobile": "3567092310",
  "children": [
    {
      "childFirstName": "John",
      "childLastName": "Doe",
      "childBirthdate": "2020-01-01T00:00:00.000Z",
      "childGender": "Male"
    }
  ]
}

Response

_idstring

The employee Kenjo _id.