Employee Enrollment

POST

/employees/upsert

This API creates a new employee record or updates an existing one based on the provided identifier (externalEmployeeId and email).
If the employee already exists, their information is updated. If not, a new record is created.

Note on status Field Behavior-
Employees will be activated or deactivated based on the value of the status field provided in the API request:
• If status = "active" → the employee will be activated
• If status = "inactive" → the employee will be deactivated
• If status is empty or null, the API will not perform any activation or deactivation action — the employee's current status will remain unchanged
Important:
To explicitly update an employee’s activation status, you must pass a valid status value ("active" or "inactive"). If omitted, the API treats the status as unchanged.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200OK

text/plain

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.skillsintelligence.imocha.io/employees/upsert' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '[
  {
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "jobCode": "string",
    "status": "string",
    "employeeHRMSInfo": {
      "externalEmployeeId": "string",
      "department": "string",
      "location": "string",
      "managerEmail": "string",
      "hireDate": "2025-07-31T05:53:20.004Z",
      "exitDate": "2025-07-31T05:53:20.004Z",
      "employmentType": "string",
      "grade": "string",
      "band": "string",
      "customFieldWithValue": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  }
]'

Response Example

{
    "failed": [
        {
            "email": "string",
            "employeeId": 0,
            "errors": "string"
        }
    ],
    "successful": [
        {
            "email": "string",
            "employeeId": 0,
            "errors": "string"
        }
    ]
}

Modified at 2025-07-31 05:58:22

Get Employee Skills by employeeId

Update Employee Status