Pular para o conteúdo principal

Desligar colaborador

Utilize esse método para desligar colaboradores na plataforma de forma imediata. Caso deseje desligar os colaboradores de forma programa, consulte a seção abaixo. Essa ação só é reversível pela plataforma.

Método

DELETE api/v2/users/:key

Headers

HeaderValor
AuthorizationBearer access_token

Obtenha o access_token pelo método de autenticação.

Atributos

Obrigatórios

AtributosTipoDescrição
keystringChave do colaborador usada no cadastro (email ou matrícula)

Resposta

200

{
"message": "Colaborador Diego Oliveira dos Santos desligado(a)"
}

401

{
"error": "access token expired"
}

Nesse caso, verifique se o access_token no header Authorization está correto.

404

{
"error": "user not found"
}

Nesse caso, não existe colaborador para a chave informada.

Programar desligamento

Utilize esse método para desligar colaboradores na plataforma de forma programada.

Método

PATCH api/v2/users/:key/terminate

Headers

HeaderValor
AuthorizationBearer access_token

Obtenha o access_token pelo método de autenticação.

Atributos

Obrigatórios

AtributosTipoDescrição
keystringChave do colaborador usada no cadastro (email ou matrícula)
schedule_datedateData de desligamento no formato DD/MM/YYYY
external_referencestringReferência externa ao seu sistema

Requisição

{
"schedule_date": "25/11/2025",
"external_reference": "REQ-001"
}
Atenção

Caso a data de desligamento não seja informada, a plataforma desligará imediamente o colaborador.

Resposta

200

{
"message": "Desligamento programado com sucesso"
}

422

{
"error": {
"message": "Já existe um desligamento programado para este(a) colaborador"
}
}

Nesse caso, um agendamento já foi realizado para o colaborador. Consulte os agendamentos realizados.

Funcionamento do agendamento

A WeCare realizará os desligamentos, por padrão, às 00:00 do dia de agendamento. Esse horário pode ser modificado para sua empresa, entre em contato com a equipe de TI por meio do email: [email protected]

Caso o desligamento falhe, enviaremos uma notificação por email aos responsáveis da empresa e também conseguimos configurar o envio de uma notificação para o seu sistema, no formato de webhook.

Cancelar o agendamento

Caso deseje cancelar o agendamento realizado, consulte os agendamentos feitos usando o endpoint:

GET api/v2/scheduled_changes

Para cancelar um agendamento, utilize o endpoint:

DELETE api/v2/scheduled_changes/:uuid/cancel

AtributosTipoDescrição
uuidstringIdentificador do agendamento de alteração