SLslant
People

Update an employment

Changed on

Update an existing employment record for a person

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

Request

  • Base URL
    https://api.slant.app
  • URL
    https://api.slant.app/v1/people/{person_id}/employments/{id}
  • Auth
    HTTP bearer

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_idstring nullable

Linked employer Business ID, when available

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
}

Changes

  • 173c41bf6be9Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      removed the invalid_json enum value from the response property for the response status

    • info

      response property detail list-of-types was narrowed by removing types array from media type application/json of response 400