Update Employee
Employees
Update Employee
PATCH
Update Employee
Documentation Index
Fetch the complete documentation index at: https://docs.salu.com.vc/llms.txt
Use this file to discover all available pages before exploring further.
Updates an existing employee.
This endpoint behaves like a real PATCH.
- Send only the fields you want to update.
- You do not need to resend all employee fields.
- Omitted fields will not be changed.
Overview
Fields
| Field | Description |
|---|---|
gov_id (CPF) | Person / Employee identifier In Brazil, every individual has a CPF (Cadastro de Pessoa Física), which is the national taxpayer ID for a person. It’s unique per person and typically does not change. In our API we expose it as gov_id. In practice, it plays a role similar to SSN (US) or a national personal tax ID in other countries. Key point: gov_id identifies the human being, not the employment relationship. |
hr_code | “Matrícula RH” (internal company HR ID) — optional hr_code corresponds to Matrícula RH, which is an internal employee code created by the company for HR/payroll/admin systems. Optional (not required by law). Used for internal controls and integrations with the company’s HRIS/payroll tools. Can vary by company and can change if the company migrates systems. Think of it as a typical Employee ID inside an organization. |
employee_registration_number | “Matrícula eSocial” (government employment link ID) — required (when applicable) employee_registration_number corresponds to Matrícula eSocial, which is an official identifier tied to the formal employment relationship under Brazilian labor law (CLT). Mandatory by law for formal employment reporting (eSocial). It is unique per employment relationship (per “job link”), not necessarily per person for life. It may not be available at onboarding, because it’s usually assigned/confirmed only after payroll/accounting formally registers the employee, including the CTPS registration. Important nuance: A person ( gov_id) can exist in the system before the Matrícula eSocial is known. Once the employment is formalized, employee_registration_number becomes the official “government-side” reference for that employment link. |
- Method:
PATCH - Path:
/v0/employee/{employee_id} - OperationId:
public_update_employee_v0_employee__employee_id__patch - Authentication: header
x-api-key
Example requests
1) Minimal partial update (single field)
employee_name field is changed; all other employee fields remain untouched.
2) Multiple fields update (omitting the rest)
employee_name, is_active, client_integration_code) will be updated; everything else remains unchanged.Authorizations
Path Parameters
Body
application/json
Available options:
Ativo, Inativo, Afastado, Férias, Pendente Available options:
M, F Available options:
Cis, Trans Available options:
Não informado, Solteiro, Casado, Separado, Desquitado, Viúvo, Outros, Divorciado, União Estável 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 Available options:
Indefinido, Branca, Preta, Parda, Amarela, Indígena, Mulato Response
Successful Response