Update Employee

Update the details of an existing employee. All fields are optional — only fields provided in the request body will be updated.

Endorsements on certain field changes

Changing name, date_of_birth, or gender on an active employee will automatically create a Modification endorsement on all their active policies. Setting date_of_leaving creates a Deletion endorsement. Use effective_date to control the endorsement date (defaults to today).

Endpoint

PUT /v1/client/employees/{employee_id}

Path Parameters

Parameter	Description
employee_id	BizzAssure internal employee ID (returned from Create Employee)

Request

Headers

Header	Value
Content-Type	application/json
Authorization	Bearer YOUR_ACCESS_TOKEN

Body

Send only the fields you want to change. Omitted fields remain unchanged.

{
  "name": "Ravi K. Kumar",
  "designation": "Senior Software Engineer",
  "department": "Platform Engineering",
  "status": "EMPLOYEE_STATUS_ACTIVE",
  "effective_date": "2024-06-01"
}

Fields

Field	Type	Description
name	string	Full name (triggers Modification endorsement on active policies)
email	string	Official email address (must be a valid email)
phone_number	string	Official phone number
date_of_birth	string	Date of birth in YYYY-MM-DD format (triggers Modification endorsement)
gender	string	GENDER_MALE, GENDER_FEMALE, or GENDER_OTHER (triggers Modification endorsement)
designation	string	Job title / designation
department	string	Department
date_of_joining	string	Date of joining in YYYY-MM-DD format
date_of_leaving	string	Date of leaving in YYYY-MM-DD format — marks the employee as inactive and triggers Deletion endorsement
address	string	Residential address
personal_email	string	Personal email address
personal_phone_number	string	Personal phone number
status	string	EMPLOYEE_STATUS_ACTIVE, EMPLOYEE_STATUS_INACTIVE, or EMPLOYEE_STATUS_INACTIVE_ONGOING_CLAIM
effective_date	string	YYYY-MM-DD date to use for any auto-generated endorsements. Defaults to today if omitted.

Response

Success (200 OK)

{
  "payload": {
    "employee_id": "ba_emp_01jwz3k...",
    "message": "Employee updated successfully",
    "success": true
  }
}

Response Fields

Field	Type	Description
employee_id	string	BizzAssure internal employee ID (unchanged)
message	string	Human-readable result message
success	boolean	true if the update was applied

Error Responses

Validation Error (400 Bad Request)

{
  "type": "VALIDATION_ERROR",
  "title": "Validation Failed",
  "detail": "gender: must be one of GENDER_MALE, GENDER_FEMALE, GENDER_OTHER",
  "instance": "/v1/client/employees/ba_emp_01jwz3k"
}

Missing Employee ID (400 Bad Request)

{
  "type": "MISSING_EMPLOYEE_ID",
  "title": "Employee ID is required",
  "detail": "Employee ID must be provided in URL path",
  "instance": "/v1/client/employees/"
}

Not Found (404)

{
  "type": "NOT_FOUND",
  "title": "Employee Not Found",
  "detail": "No employee found with the given ID",
  "instance": "/v1/client/employees/ba_emp_01jwz3k"
}