Atualizar Informações de Funcionários

Descrição

Atualiza os dados de um funcionário existente no sistema.

Parâmetros

Este endpoint requer um payload no corpo da requisição com os campos que devem ser atualizados.

🔑 Query Params

Campo	Tipo	Obrigatório	Descrição
`deletePermissions`	boolean	Não	Excluir todas as permissões existentes atribuídas ao colaborador especificado. default: `false`
`overwritePermissions`	boolean	Não	Substituir todas as permissões existentes pelas permissões fornecidas no array de permissões. Quando definido como falso, as novas permissões são adicionadas incrementalmente às permissões existentes. default: `false`
`updatePermissionsOnly`	boolean	Não	Atualizar apenas as permissões do funcionário, sem alterar nenhuma outra informação. default: `false`

📨 Corpo da Requisição (Request Body)

Campo	Tipo	Obrigatório	Descrição
`idEmployee`	integer	Sim	ID único do funcionário a ser atualizado.
`name`	string	Sim	Nome do funcionário.
`lastName`	string	Não	Sobrenome do funcionário.
`document`	string	Não	Documento de identificação (ex: CPF ou RG).
`documentId`	string	Não	ID do documento de identificação.
`cellphone`	string	Não	Número de telefone celular do funcionário.
`email`	string	Não	E-mail do funcionário.
`gender`	string	Não	Gênero do funcionário.
`birthday`	datetime	Não	Data de nascimento do funcionário (formato ISO 8601).
`country`	string	Não	País de residência do funcionário.
`address`	string	Não	Endereço completo do funcionário.
`state`	string	Não	Estado de residência do funcionário.
`city`	string	Não	Cidade de residência do funcionário.
`passport`	string	Não	Número do passaporte (se aplicável).
`zipCode`	string	Não	Código postal (CEP) do endereço do funcionário.
`complement`	string	Não	Complemento do endereço.
`neighborhood`	string	Não	Bairro de residência.
`number`	string	Não	Número do endereço residencial.
`active`	boolean	Não	Status do funcionário.
`employeeBranchPermissionsList`	array	Não	Lista de permissões do funcionário.

Requisição

Authorization

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

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

Parâmetros de Consulta

Parâmetros Bodyapplication/json-patch+json

Exemplo

{
    "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
        }
    ]
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Update employees

Atualizar Informações de Funcionários

Descrição

Parâmetros

🔑 Query Params

📨 Corpo da Requisição (Request Body)

Requisição

Exemplos de Requisição

Respostas

Update employees

Atualizar Informações de Funcionários#

Descrição#

Parâmetros#

🔑 Query Params#

📨 Corpo da Requisição (Request Body)#

Requisição

Exemplos de Requisição

Respostas

Atualizar Informações de Funcionários

Descrição

Parâmetros

🔑 Query Params

📨 Corpo da Requisição (Request Body)