API endpoints
Start typing to search…

Update the home section for a given employee id.

put https://sandbox-api.kenjo.io/api/v1/employees//homes

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.

Log in to see full request history
Path Params
string
required

The _id of the employee to update.

Body Params
string

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

string

The first name of the employee's spouse.

string

The last name of the employee's spouse.

string

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

string

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

string

The employee personal email.

string

The employee personal phone.

string

The employee personal phone

Headers
string
required

A valid bearer token.

Responses

401

UNAUTHORIZED. The Authorization header is incorrect, not provided or the token expired.

Updated about 2 months ago

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

Updated about 2 months ago