Sign in

v1

latestOpenAPI 3.0.02026-07-14800227.2 KB
Employees

Update the personal section for a given employee id.

This endpoint updates the employee personal 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 'category' belongs to the 'personal' section:

{
  ...,
  "lastName": "Nadie",
  "c_category": "Good",
  ...
}

'category' is a field type 'List' (Strings list) with the possible values: "Good" and "Bad". It means that if a different value or type is provided then the request will return an error.

put/employees/{employeeId}/personals

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

firstNamestring

The name of the Kenjo employee. This field is required.

lastNamestring

The surname of the Kenjo employee. This field is required.

displayNamestring

The composition of firstName and lastName of the Kenjo employee.

genderstring

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

birthdatestring

The employee birth date. Format YYYY-MM-DDThh:mm:ss.000Z.

nationalitystring

The employee nationality. The nationality must be the first letter in uppercase. Example "Spanish", "Brazilian"

Example request

{
  "firstName": "Juanito",
  "lastName": "Nadie",
  "displayName": "Juanito Nadie",
  "gender": "Male",
  "birthdate": "1980-01-28T00:00:00.000Z",
  "nationality": "Spanish"
}

Response

OK

_idstring

The employee Kenjo _id.

firstNamestring

The name of the Kenjo employee. This field is required.

lastNamestring

The surname of the Kenjo employee. This field is required.

displayNamestring

The composition of firstName and lastName of the Kenjo employee.

genderstring

The gender of the Kenjo employee.

birthdatestring

The employee birth date. Format YYYY-MM-DDThh:00:00.000Z.

nationalitystring

The employee nationality. The nationality must be the first letter in uppercase. Example "Spanish", "Brazilian"

Example response

{
  "_id": "60a2db290da29e126a18789a",
  "firstName": "Juanito",
  "lastName": "Nadie",
  "displayName": "Juanito Nadie",
  "gender": "male",
  "birthdate": "1980-01-28T00:00:00.000Z",
  "nationality": "Spanish"
}