API FlashAPI FlashAPI Flash
  • Guias
  • Especificação de API
Geral
Empresas
Colaboradores
    Gerenciamento de colaboradoresCriação de um ColaboradorAtualizar um ColaboradorDesativar um ColaboradorReativar um ColaboradorDeletar um ColaboradorListar ColaboradoresProcurar um Colaborador por ID
Candidatos
Beneficios
Cartão Corporativo
Cargos
Centros de custo
Controle de jornada
Departamentos
Despesas
Férias
Pagamentos
powered by Zudoku
Colaboradores

​Atualizar um Colaborador

Este endpoint é utilizado para atualizar várias informações de um colaborador específico. As informações que podem ser atualizadas incluem:

  • Email corporativo
  • Email pessoal
  • Número de telefone
  • Nome
  • ID externo
  • Data de envio do convite
  • Gestor imediato do colaborador
  • Centro de custo do colaborador

O id do colaborador (employeeId) deve ser fornecido como parte da URL do endpoint.

URL: /employees/{employeeId}
Método: PATCH
Descrição: Realiza a atualização de alguns dados do colaborador. Emails (corporativo e pessoal), número de telefone, nome, centro de custo, gestor imediato, ID externo.

ATENÇÃO: O parâmetro invitationDate, caso seja enviado, irá reagendar a data de envio do convite do colaborador e mudar o status do colaborador. Não é aceito datas passadas. Caso o agendamento seja feito para o dia atual (horário futuro), o envio será agendado para o próximo ciclo de envios, que acontece de hora em hora. Não é possível alterar a data de envio de convite para colaboradores que estão em status ACTIVE e INACTIVE

Headers:

  • x-flash-auth: <chave_api>

Parâmetros de Rota:

  • employeeId - id do documento de Colaborador

Corpo da Requisição:

{ "companyId": string, "corporateEmail": string, "email": string, "externalId": string, "invitationDate": string (date-time), "name": string, "phoneNumber": string, "costCenterId": string, "managerId": string }

Criação de um ColaboradorDesativar um Colaborador