v1

latestOpenAPI 3.0.12026-07-268028223.9 KB

People

Update an employment

Update an existing employment record for a person

patch/v1/people/{person_id}/employments/{id}

Request body

business_namestring

rolestring

start_datestring date

end_datestring date

actively_employedboolean

Example request

{
  "business_name": "New Corp",
  "role": "Director",
  "start_date": "2023-01-15",
  "end_date": "2024-12-31"
}

Response

employment updated

idstring

The employment ID

person_idstring

The person ID

business_namestring required

rolestring nullable

start_datestring date nullable

end_datestring date nullable

actively_employedboolean

Example response

{
  "id": "emp123xyz",
  "person_id": "abc123xyz",
  "business_name": "Acme Corp",
  "role": "Software Engineer",
  "start_date": "2023-01-15",
  "end_date": "2024-12-31",
  "actively_employed": true
}