Skip to main content
PUT
Update Employee Personal Data

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

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