Skip to main content
PUT
/
organizations
/
{organization_id}
/
employees
/
{employee_id}
/
personal-data
Update Employee Personal Data
curl --request PUT \
  --url https://dev.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/personal-data \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "employeeName": {
    "familyName": "<string>",
    "givenName": "<string>",
    "familyNamePrefix": "<string>",
    "givenNameSuffix": "<string>",
    "birthName": "<string>",
    "birthFamilyNamePrefix": "<string>",
    "birthGivenNameSuffix": "<string>",
    "title": "<string>"
  }
}
'
{
  "employeeId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "id": 123,
  "employeeName": {
    "familyName": "<string>",
    "givenName": "<string>",
    "familyNamePrefix": "<string>",
    "givenNameSuffix": "<string>",
    "birthName": "<string>",
    "birthFamilyNamePrefix": "<string>",
    "birthGivenNameSuffix": "<string>",
    "title": "<string>"
  },
  "employmentCountry": "DE",
  "gender": "M",
  "maritalStatus": "Single",
  "nationality": "<string>",
  "residenceAddress": "<string>",
  "statusIndicator": "managing_partner_gmbh_ug",
  "validFrom": "2023-12-25",
  "validTo": "2023-12-25"
}

Authorizations

​
Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

​
organization_id
required
​
employee_id
required

Body

application/json

Schema for personal data of a German employee. Change tracked personal data.

​
employeeName
DEName · object
required

EN: Employee name | DE: Mitarbeitername

​
employmentCountry
string
default:DE
Allowed value: "DE"
​
gender
enum<string> | null

EN: Gender | DE: Geschlecht)

Available options:
M,
W,
D
​
maritalStatus
enum<string> | null

EN: Marital status | DE: Familienstand

Available options:
Single,
Married
​
nationality
string | null

EN: Nationality | DE: Staatsangehörigkeit

Example:

"German"

​
residenceAddress
string | null

EN: Residence address | DE: Wohnadresse

Example:

"Taigschuster 11, 82380 Peissenberg, Germany"

​
statusIndicator
enum<string> | null

EN: Employee status indicator | DE: Statuskennzeichen

Available options:
managing_partner_gmbh_ug,
proprietor_spouse,
proprietor_life_partner,
proprietor_biological_child,
proprietor_adopted_child,
proprietor_grandchild
​
validFrom
string<date> | null

EN: Valid from date | DE: Gültig ab Datum

​
validTo
string<date> | null

EN: Valid to date | DE: Gültig bis Datum

Response

Successful Response

Response model for personal data with metadata fields.

​
employeeId
string
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
id
integer
required
​
employeeName
DEName · object
required
​
employmentCountry
string
default:DE
Allowed value: "DE"
​
gender
enum<string> | null

Legally recognized genders in Germany.

Available options:
M,
W,
D
​
maritalStatus
enum<string> | null
Available options:
Single,
Married
​
nationality
string | null
​
residenceAddress
string | null
​
statusIndicator
enum<string> | null

EN: Employee status indicator | DE: Statuskennzeichen

Available options:
managing_partner_gmbh_ug,
proprietor_spouse,
proprietor_life_partner,
proprietor_biological_child,
proprietor_adopted_child,
proprietor_grandchild
​
validFrom
string<date> | null

EN: Valid from date | DE: Gültig ab Datum

​
validTo
string<date> | null

EN: Valid to date | DE: Gültig bis Datum