Sign in
latestOpenAPI 3.0.1Proprietary2026-08-1844131294.9 KB

59cd6443fdbf

Employee Employment Details

Update employee employment details

Update employment details for a specific employee.

This endpoint allows partial updates to employment information. Only the fields provided in the request body will be updated; other fields remain unchanged.

Important: At least one field must be provided in the request body. Empty requests (no-op operations) are not allowed and will return a 400 Bad Request.

Currently Supported Fields (Phase 1):

  • employeeCode - The employee's unique identifier code within the organization

Future Fields (Planned):

  • designation - Job title or position
  • department - Department name
  • workEmail - Work email address
  • noticePeriod - Notice period details

Read-Only Fields (Not Updatable): Fields such as entity, startDate, endDate, status, type, and term are managed through other processes and cannot be updated via this endpoint.

patch/v1/employees/{employeeId}/employment

Path parameters

employeeIdstring uuid required

Unique identifier for the employee

Request body

employeeCodestring

The employee's unique identifier code within the organization. Must be alphanumeric with hyphens and underscores allowed.

Example request

{
  "employeeCode": "EMP-2024-001"
}

Response

Employee employment details updated successfully

employeeIdstring uuid required

Unique identifier for the employee (employment public ID)

employeeCodestring required

The updated employee code

Example response

{
  "employeeId": "123e4567-e89b-12d3-a456-426614174000",
  "employeeCode": "EMP-2024-001"
}