Update an associated person
Updates the specified associated person by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Path parameters
employee_id
associated_person_id
Request
This endpoint expects an object.
first_name
NOTE: This field will be normalized according to our internal formatting rules.
last_name
NOTE: This field will be normalized according to our internal formatting rules.
date_of_birth
Must be in the past, but after 1900-01-01
sex_at_birth
The sex assigned to the associated person at birth
Allowed values:
relationship_type
The relationship type between the employee and the associated person
Allowed values:
email
Email address of the associated person. If null is provided, the email will be cleared. NOTE: This field will be normalized according to our internal formatting rules.
phone_number
Phone number in E.164 international format (e.g. +447700900999). If null is provided, the phone number will be cleared. NOTE: This field will be normalized according to our internal formatting rules.
Response
OK
id
Unique identifier for the associated person
employee_id
Unique identifier for the employee this person is associated with
first_name
First name of the associated person
last_name
Last name of the associated person
date_of_birth
Date of birth of the associated person
sex_at_birth
The sex assigned to the associated person at birth
Allowed values:
relationship_type
The relationship type between the employee and the associated person
Allowed values:
platform_id
Unique identifier for the platform
email
Email address of the associated person
phone_number
Phone number in E.164 international format (e.g. +447700900999)
object
The object type
