Patch Employee

PATCH

/apis/external/employee/:code

Patch Employee

This API is used to update employee information by providing the employee code in the endpoint URL. The request body should contain the updated employee details in JSON format.

Request Body

Params	Required	Type	Description
name.first	Optional	String	The first name of the employee.
name.last	Optional	String	The last name of the employee.
email	Optional	String	The email address of the employee.
mobile	Optional	String	The mobile number of the employee.
dob	Optional	Integer	The date of birth of the employee in Unix timestamp format.
managerCode	Optional	String	The code of the manager for the employee.
alternateManagerCode	Optional	String	The code of the alternate manager for the employee.
hrHeadCode	Optional	String	The code of the HR head for the employee.
officeIds	Optional	Array	An array of office IDs associated with the employee.
eaCode	Optional	String	The EA code of the employee.
customFields	Optional	Object	Additional custom fields for the employee.
qrDisabled	Optional	Boolean	A flag to indicate if the QR code is disabled for the employee.

Response

The response will contain a success field indicating whether the update was successful.

Example

{
    "success": true
}

Path parameters

codestringRequired

Request

This endpoint expects an object.

nameobjectRequired

emailstringRequiredformat: "email"

mobilestringRequired

dobintegerRequired

managerCodestringRequired

alternateManagerCodestringRequired

hrHeadCodestringRequired

officeIdslist of anyRequired

eaCodestringRequired

customFieldsobjectRequired

qrDisabledbooleanRequired

Response

successboolean

Patch Employee

Request Body

Response

Example

Path parameters

Headers

Request

Response