Skip to content

Altera o cadastro de um empregado

PATCH/api/time-tracking/employees/{id}

Auth
Requires a token
API key:
No API key accepted
X-CommunityId
X-CommunityId Send the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

Gestão do ponto. Qualquer mudança (CPF, nome, admissão, cargo, matrícula) grava um registro tipo 5 "A"; sem mudança, nada é gravado.

Parameters

NameInTypeDescription
idrequiredpathstring (uuid)

Headers

NameTypeDescription
X-CommunityIdoptionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Request body application/json

NameTypeDescription
cpfoptionalstring
nameoptionalstringmax 52
admissionDateoptionalstring (date)
jobTitleoptionalstringmax 100
esocialRegistrationoptionalstringmax 30
responsibleCpfoptionalstring

Responses

StatusDescription
200Cadastro atualizado.
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
403Só a gestão do ponto (owner, admin, financeiro): `timeTracking.errors.managementOnly`; quem não tem cadastro de empregado: `notEmployee`; sessão de suporte do SuperAdmin: `supportSession`.
404Recurso não encontrado.
409Conflito com o estado atual do recurso.
422Dado inválido (CPF ou CNPJ com dígito errado, dia, período, campo obrigatório, pessoa sem acesso ao espaço, CPF do responsável ausente).

curl example

curl -X PATCH "https://api.memberfy.net/api/time-tracking/employees/<id>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'