Update Employee Information

Description

Updates the data of an existing employee in the system.

Parameters

This endpoint requires a payload in the request body with the fields that need to be updated.

🔑 Query Params

Field	Type	Required	Description
`deletePermissions`	boolean	No	Delete all existing permissions assigned to the specified staff member. Default: `false`
`overwritePermissions`	boolean	No	Replace all existing permissions with the permissions provided in the permissions array. When set to false, new permissions are incrementally added to existing permissions. Default: `false`
`updatePermissionsOnly`	boolean	No	Update only the permissions of the employee, without changing any other information. Default: `false`
`idBranch`	`int32`	`No`	Filter by branch number (only applicable for multi-location keys; ignored otherwise).

📨 Request Body

Field	Type	Required	Description
`idEmployee`	integer	Yes	Unique ID of the employee to be updated.
`name`	string	Yes	Name of the employee.
`lastName`	string	No	Last name of the employee.
`document`	string	No	Identification document (e.g., CPF or RG).
`documentId`	string	No	ID of the identification document.
`cellphone`	string	No	Employee's mobile phone number.
`email`	string	No	Employee's email.
`gender`	string	No	Gender of the employee.
`birthday`	datetime	No	Employee's date of birth (ISO 8601 format).
`country`	string	No	Country of residence of the employee.
`address`	string	No	Complete address of the employee.
`state`	string	No	State of residence of the employee.
`city`	string	No	City of residence of the employee.
`passport`	string	No	Passport number (if applicable).
`zipCode`	string	No	Postal code (CEP) of the employee's address.
`complement`	string	No	Address complement.
`neighborhood`	string	No	Neighborhood of residence.
`number`	string	No	Residential address number.
`active`	boolean	No	Status of the employee.
`employeeBranchPermissionsList`	array	No	List of permissions for the employee.

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Query Params

Body Params

application/json-patch+json

Example

{
    "idEmployee": 0,
    "name": "string",
    "lastName": "string",
    "document": "string",
    "documentId": "string",
    "cellphone": "string",
    "email": "string",
    "gender": "string",
    "birthday": "2019-08-24T14:15:22.123Z",
    "country": "string",
    "address": "string",
    "state": "string",
    "city": "string",
    "passport": "string",
    "zipCode": "string",
    "complement": "string",
    "neighborhood": "string",
    "number": "string",
    "active": true,
    "employeeBranchPermissionsList": [
        {
            "idPermission": 0,
            "idBranchPermission": 0,
            "idBranchGroupPermission": 0
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Update employees

Update Employee Information

Description

Parameters

🔑 Query Params

📨 Request Body

Request

Request Code Samples

Responses

Update employees

Update Employee Information#

Description#

Parameters#

🔑 Query Params#

📨 Request Body#

Request

Request Code Samples

Responses

Update Employee Information

Description

Parameters

🔑 Query Params

📨 Request Body