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 '
{
  "employee_name": {
    "family_name": "<string>",
    "given_name": "<string>",
    "family_name_prefix": "<string>",
    "given_name_suffix": "<string>",
    "birth_name": "<string>",
    "birth_family_name_prefix": "<string>",
    "birth_given_name_suffix": "<string>",
    "title": "<string>"
  }
}
'
import requests

url = "https://dev.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/personal-data"

payload = { "employee_name": {
"family_name": "<string>",
"given_name": "<string>",
"family_name_prefix": "<string>",
"given_name_suffix": "<string>",
"birth_name": "<string>",
"birth_family_name_prefix": "<string>",
"birth_given_name_suffix": "<string>",
"title": "<string>"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
employee_name: {
family_name: '<string>',
given_name: '<string>',
family_name_prefix: '<string>',
given_name_suffix: '<string>',
birth_name: '<string>',
birth_family_name_prefix: '<string>',
birth_given_name_suffix: '<string>',
title: '<string>'
}
})
};

fetch('https://dev.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/personal-data', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://dev.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/personal-data",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'employee_name' => [
'family_name' => '<string>',
'given_name' => '<string>',
'family_name_prefix' => '<string>',
'given_name_suffix' => '<string>',
'birth_name' => '<string>',
'birth_family_name_prefix' => '<string>',
'birth_given_name_suffix' => '<string>',
'title' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://dev.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/personal-data"

payload := strings.NewReader("{\n \"employee_name\": {\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"family_name_prefix\": \"<string>\",\n \"given_name_suffix\": \"<string>\",\n \"birth_name\": \"<string>\",\n \"birth_family_name_prefix\": \"<string>\",\n \"birth_given_name_suffix\": \"<string>\",\n \"title\": \"<string>\"\n }\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://dev.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/personal-data")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"employee_name\": {\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"family_name_prefix\": \"<string>\",\n \"given_name_suffix\": \"<string>\",\n \"birth_name\": \"<string>\",\n \"birth_family_name_prefix\": \"<string>\",\n \"birth_given_name_suffix\": \"<string>\",\n \"title\": \"<string>\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://dev.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/personal-data")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"employee_name\": {\n \"family_name\": \"<string>\",\n \"given_name\": \"<string>\",\n \"family_name_prefix\": \"<string>\",\n \"given_name_suffix\": \"<string>\",\n \"birth_name\": \"<string>\",\n \"birth_family_name_prefix\": \"<string>\",\n \"birth_given_name_suffix\": \"<string>\",\n \"title\": \"<string>\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "employee_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "id": 123,
  "employee_name": {
    "family_name": "<string>",
    "given_name": "<string>",
    "family_name_prefix": "<string>",
    "given_name_suffix": "<string>",
    "birth_name": "<string>",
    "birth_family_name_prefix": "<string>",
    "birth_given_name_suffix": "<string>",
    "title": "<string>"
  },
  "employment_country": "DE",
  "nationality": "<string>",
  "residence_address": "<string>",
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

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.

employee_name
DEName · object
required

EN: Employee name | DE: Mitarbeitername

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

EN: Gender | DE: Geschlecht)

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

EN: Marital status | DE: Familienstand

Available options:
Single,
Married
nationality
string | null

EN: Nationality | DE: Staatsangehörigkeit

Example:

"German"

residence_address
string | null

EN: Residence address | DE: Wohnadresse

Example:

"Taigschuster 11, 82380 Peissenberg, Germany"

status_indicator
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
valid_from
string<date> | null

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

valid_to
string<date> | null

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

Response

Successful Response

Response model for personal data with metadata fields.

employee_id
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
id
integer
required
employee_name
DEName · object
required
employment_country
string
default:DE
Allowed value: "DE"
gender
enum<string> | null

Legally recognized genders in Germany.

Available options:
M,
W,
D
marital_status
enum<string> | null
Available options:
Single,
Married
nationality
string | null
residence_address
string | null
status_indicator
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
valid_from
string<date> | null

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

valid_to
string<date> | null

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