Skip to main content

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

HeaderValue
Content-Typeapplication/json
AuthorizationBearer YOUR_ACCESS_TOKEN

Path Parameters

ParameterTypeRequiredDescription
employee_idstringYesBizzAssure 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.

FieldTypeDescription
namestringFull name of the employee
emailstringOfficial email address (must be a valid email)
phone_numberstringOfficial phone number
date_of_birthstringDate of birth in YYYY-MM-DD format
genderstringGENDER_MALE, GENDER_FEMALE, or GENDER_OTHER
designationstringJob title / designation
departmentstringDepartment the employee belongs to
date_of_joiningstringDate of joining in YYYY-MM-DD format
addressstringResidential address
personal_emailstringPersonal email address
personal_phone_numberstringPersonal phone number
statusstringEMPLOYEE_STATUS_ACTIVE, EMPLOYEE_STATUS_INACTIVE, EMPLOYEE_STATUS_INACTIVE_ONGOING_CLAIM
last_active_datestringLast 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

FieldTypeDescription
employee_idstringBizzAssure internal employee ID
messagestringHuman-readable result message
successbooleantrue 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"
}