Skip to main content
PATCH
/
v0
/
employee
/
{employee_id}
Update Employee
curl --request PATCH \
  --url https://public-api.salu.com.vc/dev/routes/v0/employee/{employee_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "address": "<string>",
  "address_number": "<string>",
  "address_detail": "<string>",
  "zip_code": "<string>",
  "neighborhood": "<string>",
  "state": "<string>",
  "city": "<string>",
  "name": "<string>",
  "social_name": "<string>",
  "gov_id": "<string>",
  "birth_date": "2023-12-25",
  "is_disabled": true,
  "status": "Ativo",
  "sex": "M",
  "gender": "Cis",
  "mother_name": "<string>",
  "marital_status": "Não informado",
  "place_of_birth": "<string>",
  "educational_stage": "Indefinida",
  "human_skin_tone": "Indefinido",
  "phone": "<string>",
  "cell_phone": "<string>",
  "email": "<string>",
  "personal_email": "<string>",
  "admission_date": "2023-12-25",
  "hr_code": "<string>",
  "employee_registration_number": "<string>",
  "work_shift": "<string>",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "position_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sector_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "client_integration_code": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "is_disabled": true,
  "status": "<string>",
  "sex": "<string>",
  "admission_date": "2023-12-25",
  "is_active": true,
  "organization": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "branch": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "position": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "sector": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "social_name": "<string>",
  "gov_id": "<string>",
  "birth_date": "2023-12-25",
  "gender": "<string>",
  "mother_name": "<string>",
  "marital_status": "<string>",
  "place_of_birth": "<string>",
  "educational_stage": "<string>",
  "human_skin_tone": "<string>",
  "phone": "<string>",
  "cell_phone": "<string>",
  "email": "<string>",
  "personal_email": "<string>",
  "dismissal_date": "2023-12-25",
  "hr_code": "<string>",
  "employee_registration_number": "<string>",
  "work_shift": "<string>",
  "client_integration_code": "<string>",
  "address": {
    "address": "<string>",
    "address_number": "<string>",
    "address_detail": "<string>",
    "zip_code": "<string>",
    "neighborhood": "<string>",
    "state": "<string>",
    "city": "<string>"
  }
}
Atualiza dados de um funcionário existente.
Este endpoint funciona como um PATCH real.
  • Envie apenas os campos que deseja atualizar.
  • Não é necessário reenviar todos os campos do funcionário.
  • Campos omitidos não serão alterados.

​
Visão Geral

​
Campos

CampoDescrição
gov_id (CPF)Identificador da Pessoa / Funcionário
No Brasil, toda pessoa física possui um CPF (Cadastro de Pessoa Física), que é o número de identificação do contribuinte nacional. É único por pessoa e normalmente não muda. Em nossa API, ele é exposto como gov_id. Na prática, desempenha um papel semelhante ao SSN (nos EUA) ou a um número de identificação fiscal pessoal em outros países.
Ponto chave: gov_id identifica o ser humano, não a relação de trabalho.
hr_code“Matrícula RH” (ID interno de RH da empresa) — opcional
Corresponde à Matrícula RH, que é um código interno do funcionário criado pela empresa para sistemas de RH/folha de pagamento/administrativos. Opcional (não exigido por lei). Usado para controles internos e integrações com as ferramentas de HRIS/folha de pagamento da empresa. Pode variar de empresa para empresa e pode mudar se a empresa migrar de sistemas. Pense nisso como um ID de Funcionário típico dentro de uma organização.
employee_registration_number“Matrícula eSocial” (ID de vínculo empregatício do governo) — obrigatório (quando aplicável)
Corresponde à Matrícula eSocial, que é um identificador oficial vinculado à relação de trabalho formal sob a legislação trabalhista brasileira (CLT). Obrigatório por lei para o reporte formal de emprego (eSocial). É único por relação de trabalho (por “vínculo de trabalho”), não necessariamente por pessoa para toda a vida. Pode não estar disponível na admissão, pois geralmente é atribuído/confirmado somente após a folha de pagamento/contabilidade registrar formalmente o funcionário, incluindo o registro na CTPS.
Nuance importante: Uma pessoa (gov_id) pode existir no sistema antes que a Matrícula eSocial seja conhecida. Uma vez que o emprego é formalizado, employee_registration_number se torna a referência oficial do “lado do governo” para aquele vínculo empregatício.
  • Método: PATCH
  • Path: /v0/employee/{employee_id}
  • OperationId: public_update_employee_v0_employee__employee_id__patch
  • Autenticação: header x-api-key

​
Exemplos de requisição

​
1) Atualização parcial mínima (somente um campo)

curl -X PATCH "https://public-api.salu.com.vc/dev/routes/v0/employee/EMPLOYEE_ID_AQUI" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $SALU_PUBLIC_API_KEY" \
  --data '{
    "employee_name": "Maria de Souza"
  }'
Neste exemplo, apenas o campo employee_name será alterado; os demais campos do funcionário permanecem inalterados.

​
2) Atualização de múltiplos campos (omitindo os demais)

curl -X PATCH "https://public-api.salu.com.vc/dev/routes/v0/employee/EMPLOYEE_ID_AQUI" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $SALU_PUBLIC_API_KEY" \
  --data '{
    "employee_name": "Maria de Souza",
    "is_active": true,
    "client_integration_code": "EMP-001-INT"
  }'
Somente os campos presentes no corpo (employee_name, is_active, client_integration_code) serão atualizados; todos os outros permanecem como estão.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
employee_id
string<uuid>
required

Body

application/json
​
address
string | null
​
address_number
string | null
​
address_detail
string | null
​
zip_code
string | null
​
neighborhood
string | null
​
state
string | null
​
city
string | null
​
name
string | null
​
social_name
string | null
​
gov_id
string | null
​
birth_date
string<date> | null
​
is_disabled
boolean | null
​
status
enum<string> | null
Available options:
Ativo,
Inativo,
Afastado,
Férias,
Pendente
​
sex
enum<string> | null
Available options:
M,
F
​
gender
enum<string> | null
Available options:
Cis,
Trans
​
mother_name
string | null
​
marital_status
enum<string> | null
Available options:
Não informado,
Solteiro,
Casado,
Separado,
Desquitado,
Viúvo,
Outros,
Divorciado,
União Estável
​
place_of_birth
string | null
​
educational_stage
enum<string> | null
Available options:
Indefinida,
Ensino Fundamental Incompleto,
Ensino Fundamental Completo,
Ensino Medio Incompleto,
Ensino Medio Completo,
Ensino Superior Incompleto,
Ensino Superior Completo,
Profissionalizante,
Técnico Incompleto,
Técnico Completo,
Tecnólogo Incompleto,
Tecnólogo Completo,
Pós-graduação Incompleta,
Pós-graduação Completo,
Mestrado Incompleto,
Mestrado Completo,
Doutorado Incompleto,
Doutorado Completo,
PHD Incompleto,
PHD Completo,
Não Informado,
Analfabeto
​
human_skin_tone
enum<string> | null
Available options:
Indefinido,
Branca,
Preta,
Parda,
Amarela,
Indígena,
Mulato
​
phone
string | null
​
cell_phone
string | null
​
email
string | null
​
personal_email
string | null
​
admission_date
string<date> | null
​
hr_code
string | null
​
employee_registration_number
string | null
​
work_shift
string | null
​
organization_id
string<uuid> | null
​
branch_id
string<uuid> | null
​
position_id
string<uuid> | null
​
sector_id
string<uuid> | null
​
client_integration_code
string | null

Response

Successful Response

​
id
string<uuid>
required
​
name
string
required
​
is_disabled
boolean
required
​
status
string
required
​
sex
string
required
​
admission_date
string<date>
required
​
is_active
boolean
required
​
organization
SimpleEntity · object
required
​
branch
SimpleEntity · object
required
​
position
SimpleEntity · object
required
​
sector
SimpleEntity · object
required
​
social_name
string | null
​
gov_id
string | null
​
birth_date
string<date> | null
​
gender
string | null
​
mother_name
string | null
​
marital_status
string | null
​
place_of_birth
string | null
​
educational_stage
string | null
​
human_skin_tone
string | null
​
phone
string | null
​
cell_phone
string | null
​
email
string | null
​
personal_email
string | null
​
dismissal_date
string<date> | null
​
hr_code
string | null
​
employee_registration_number
string | null
​
work_shift
string | null
​
client_integration_code
string | null
​
address
Address · object