Update Employee

Overview

Updates an existing employee record. All provided fields will overwrite the current values. The employee's referralCode is not affected by updates — it remains the same as when the employee was originally created.

Command Details

• Command: UpdateEmployeeCommand
• Type: Command (write operation)

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
$type	string	Yes	Must be UpdateEmployeeCommand
id	long	Yes	The employee record ID
staffId	string	Yes	Unique staff identifier
email	string	Yes	Employee email address
title	string	No	Title (e.g., Mr, Mrs, Dr)
firstName	string	Yes	Employee first name
lastName	string	Yes	Employee last name
middleName	string	No	Employee middle name
dateOfBirth	string	No	Date of birth (ISO 8601)
branch	string	No	Branch name or code
role	string	No	Employee role or position
isAccountOfficer	bool	No	Whether the employee is an account officer (default: false)
canReferCustomer	bool	No	Whether the employee can refer customers (default: true)
isEnabled	bool	No	Whether the employee is enabled/active for operations
note	string	No	Additional notes
contactDetails	object	No	Contact information object
contactDetails.mobile	string	No	Mobile phone number
contactDetails.addressLine1	string	No	Address line 1
contactDetails.addressLine2	string	No	Address line 2
contactDetails.city	string	No	City
contactDetails.state	string	No	State or province
contactDetails.zipCode	string	No	ZIP or postal code
contactDetails.country	string	No	Country

Try It Out

POST/api/bpm/cmdUpdateEmployeeCommand

Base URL

Bearer Token

Request Body

{ "cmd": "UpdateEmployeeCommand", "data": { "id": 101, "staffId": "EMP-001234", "email": "john.doe@company.com", "title": "Mr", "firstName": "John", "lastName": "Doe", "branch": "Victoria Island Branch", "role": "Senior Relationship Manager", "isAccountOfficer": true, "canReferCustomer": true, "isEnabled": true, "contactDetails": { "mobile": "08012345678", "addressLine1": "25 Adeola Odeku Street", "city": "Lagos", "state": "Lagos", "country": "Nigeria" } } }

Response Structure

Success:

{
  "success": true,
  "data": {
    "id": 101,
    "staffId": "EMP-001234",
    "email": "john.doe@company.com",
    "firstName": "John",
    "lastName": "Doe",
    "branch": "Victoria Island Branch",
    "branchName": "Victoria Island Branch",
    "role": "Senior Relationship Manager",
    "roleName": "Senior Relationship Manager",
    "isAccountOfficer": true,
    "canReferCustomer": true,
    "isEnabled": true,
    "updatedAt": "2026-03-09T14:00:00Z"
  },
  "message": "Employee updated successfully"
}

Error:

{
  "success": false,
  "data": null,
  "message": "Update failed",
  "errors": [
    "Employee not found"
  ]
}

Related Operations

• Create Employee — Create a new employee record
• Retrieve Employee by ID — Get details of this employee
• Retrieve Employees — List all employees