v1

latestOpenAPI 3.0.02026-07-14800227.2 KB
Employees

Update the address section for a given employee id.

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

{
  ...,
  "country": "ES",
  "c_province": "MD",
  ...
}

'province' 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}/addresses

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

streetstring

The name of the street.

postalCodestring

The postal code.

citystring

The city.

countrystring

The country code in ISO 3166-1 alpha-2.

houseNumberstring

The house number.

additionalAddressstring

The additional address.

Response

OK

_idstring

The employee Kenjo _id.

streetstring

The name of the street.

postalCodestring

The postal code.

citystring

The city.

countrystring

The country code in ISO 3166-1 alpha-2.

houseNumberstring

The house number.

additionalAddressstring

The additional address.

Example response

{
  "_id": "60a2db290da29e126a18789a"
}