Update Employee
Update one or more fields on an existing employee's profile. Only the fields provided in the request body will be updated; all other fields remain unchanged.
Endpoint
PUT /v1/client/employees/{employee_id}
Request
Headers
| Header | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer YOUR_ACCESS_TOKEN |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| employee_id | string | Yes | BizzAssure internal employee ID returned when the employee was created |
Body
{
"designation": "Senior Software Engineer",
"department": "Platform Engineering",
"status": "EMPLOYEE_STATUS_INACTIVE",
"last_active_date": "2025-12-31"
}
Fields
All body fields are optional. Only fields included in the request are updated.
| Field | Type | Description |
|---|---|---|
| name | string | Full name of the employee |
| 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 |
| gender | string | GENDER_MALE, GENDER_FEMALE, or GENDER_OTHER |
| designation | string | Job title / designation |
| department | string | Department the employee belongs to |
| date_of_joining | string | Date of joining in YYYY-MM-DD format |
| 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, EMPLOYEE_STATUS_INACTIVE_ONGOING_CLAIM |
| last_active_date | string | Last date the employee was active, in YYYY-MM-DD format |
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 |
| message | string | Human-readable result message |
| success | boolean | true if the employee was updated |
Error Responses
Validation Error (400 Bad Request)
{
"type": "VALIDATION_ERROR",
"title": "Validation Failed",
"detail": "last_active_date: must be in YYYY-MM-DD format",
"instance": "/v1/client/employees/ba_emp_01jwz3k"
}
Not Found (404)
{
"type": "NOT_FOUND",
"title": "Employee Not Found",
"detail": "Employee with the given ID does not exist",
"instance": "/v1/client/employees/ba_emp_01jwz3k"
}
Unauthorized (401 Unauthorized)
{
"type": "UNAUTHORIZED",
"title": "Unauthorized",
"detail": "Missing or invalid access token",
"instance": "/v1/client/employees/ba_emp_01jwz3k"
}