Atualizar colaborador

PUT /api/v1/valepix/employees/{employee_id}

Atualiza dados cadastrais de um colaborador.

Autenticação

Envie um API token ativo no header Authorization.

Authorization: Bearer <VALEPIX_API_TOKEN>
Accept: application/json
Content-Type: application/json

Path params

Parâmetro	Tipo	Obrigatório	Descrição
employee_id	string	Sim	Identificador do colaborador retornado pela API

Body

Todos os campos do body de atualização são opcionais. Envie apenas os campos que deseja alterar.

Campo	Tipo	Descrição
benefit_id	string	Novo benefício do colaborador, obtido pelas rotas de benefícios
name	string	Nome do colaborador
email	string	E-mail do colaborador
phone	string	Telefone brasileiro válido
cbo	string	Código CBO
situation	string	Situação cadastral. Valores aceitos: active, blocked, vacation, sick_leave, maternity_leave, dismissed. Veja Situações de colaboradores
admission_date	string	Data de admissão em YYYY-MM-DD
birth_date	string	Data de nascimento em YYYY-MM-DD

Antes de alterar benefit_id, obtenha o novo identificador em Listar benefícios ou Criar benefício. Para criar um benefício, obtenha antes o product_id em Listar produtos. Para alterar situation, use um valor retornado por Situações de colaboradores.

Envie apenas os campos que deseja alterar. Strings vazias não apagam os valores existentes. Depois que a conta do colaborador for ativada, email e phone não podem mais ser alterados por esta rota. O employee_id vem da URL.

Exemplo curl

curl --request PUT \
  --header "Authorization: Bearer $VALEPIX_API_TOKEN" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --url "https://routes.valepix.com.br/api/v1/valepix/employees/$EMPLOYEE_ID" \
  --data '{
    "name": "Maria Exemplo Santos",
    "cbo": "4110-05",
    "situation": "active"
  }'

Response

HTTP 200 OK.

{
  "success": "success",
  "data": {
    "success": true
  }
}

Erros comuns

HTTP	Quando acontece	Ação recomendada
400	Identificador, telefone, data, situação ou benefício inválido; ou tentativa de alterar contato após ativação da conta	Corrigir dados enviados
401	Token ausente, inválido, expirado ou revogado	Conferir token
403	Token sem acesso ao recurso solicitado	Confirmar token com a ValePix
404	Colaborador não encontrado	Conferir employee_id
429	Limite de chamadas excedido	Reduzir a frequência e aplicar backoff
500, 502, 503, 504	Falha temporária na atualização	Tentar novamente com backoff