Skip to main content
PATCH
/
colaborador
/
{collaboratorId}
curl --request PATCH \
  --url https://api.example.com/colaborador/{collaboratorId} \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "status": true,
  "mensagem": "OK"
}

Path Parameters

collaboratorId
string
required

Id do colaborador

Body

application/json

Dados do colaborador

collaboratorType
enum<string>
default:CLT

Identificação se será um Colaborador CLT ou Prestador de Serviço

Available options:
CLT,
PRESTADOR_SERVICO
documentNumber
string

CPF ou CNPJ

Example:

"71055398712"

nameOrCorporateName
string

Nome ou razão social

Example:

"Douglas Vitor"

fullName
string

Nome completo do colaborador

Example:

"Douglas Fernandez Coelho"

birthDate
string<date-time>

Data de nascimento

Example:

"2026-04-26T19:36:23.055Z"

maritalStatus
enum<string>
default:SOLTEIRO

Estado civil

Available options:
SOLTEIRO,
CASADO,
SEPARADO,
DIVORCIADO,
VIUVO
gender
enum<string>
default:MASCULINO

Genero

Available options:
MASCULINO,
FEMININO,
OUTRO
fantasyName
string

Nome fantasia

Example:

"STW Tecnologia"

stateRegistration
string

Inscrição estadual

Example:

"123456789"

isStateRegistrationExempt
boolean
default:false

Inscrição estadual está isenta?

cityRegistration
string

Inscrição municipal

Example:

"987654321"

isCityRegistrationExempt
boolean
default:false

Inscrição municipal está isenta?

socialSecurityNumber
string

Número do tipo de vínculo previdenciário do empregado (NIS, PIS, etc)

Example:

"N586692225"

eSocialRegistration
string

Matrícula do eSocial

Example:

"Douglas Vitor"

internalRegistration
string

Matrícula interna da empresa

Example:

"49172594718"

email
string

Email do empregado

Example:

"douglas@pontua.com.br"

cellphone
string

Número do telefone celular do empregado

Example:

"62993610391"

address
object

Endereço do empregado

bondType
enum<string>
default:CLT

Tipo de vínculo

Available options:
CLT,
APRENDIZ,
ESTAGIO,
AUTONOMO,
INTERMITENTE,
OUTROS
hasUnhealthinessSupplement
boolean

Se o empregado terá adicional de Insalubridade

Example:

false

unhealthinessValue
enum<string>
default:GRAU_MEDIO_20

Selecionar o grau de Insalubridade

Available options:
GRAU_MINIMO_10,
GRAU_MEDIO_20,
GRAU_MAXIMO_40
hasHazardPay
boolean

Se o empregado terá adicional de Insalubridade

Example:

false

positionId
string

ID referente ao cargo

Example:

"b5887a64-6aa1-43e8-b233-ffadc7f92ca6"

departmentId
string

ID referente ao departamento

Example:

"c9f447fe-f97f-4f24-974d-9f92eb3049dc"

teamId
string

ID referente à equipe

Example:

"f029e9b4-5943-4650-bb67-8c6f19d78345"

salary
number

Salário do empregado

Example:

7400

salaryType
enum<string>
default:SALARIO_FIXO

Tipo de remuneração do empregado

Available options:
SALARIO_FIXO,
POR_HORA,
DIARIAS,
PRESTACAO_SERVICO
timeZone
enum<string>
default:SAO_PAULO

Fuso horário

Available options:
MANAUS,
NORONHA,
RIO_BRANCO,
SAO_PAULO
workplaceId
string

ID referente ao local de trabalho

Example:

"f029e9b4-5943-4650-bb67-8c6f19d78345"

costCenterId
string

ID referente ao centro de custo

Example:

"b5887a64-6aa1-43e8-b233-ffadc7f92ca6"

admissionDate
string<date-time>

Data de admissão do colaborador

Example:

"2023-11-20T00:00:00.000Z"

startDate
string<date-time>

Data de inicio do colaborador

Example:

"2023-11-20T00:00:00.000Z"

calendarId
string

ID referente ao calendário de trabalho da empresa, onde colocorá o colaborador

Example:

"b5887a64-6aa1-43e8-b233-ffadc7f92ca6"

shiftId
string

ID referente ao turno, onde colocorá o colaborador

Example:

"b5887a64-6aa1-43e8-b233-ffadc7f92ca6"

logoBase64
file

Base64 da foto do colaborador

punchConfigId
string

ID da batida de ponto que o colaborador terá

Example:

"b5887a64-6aa1-43e8-b233-ffadc7f92ca6"

punchRuleId
string

ID referente a regra de ponto atribuida ao empregado

Example:

"b5887a64-6aa1-43e8-b233-ffadc7f92ca6"

useStandardConfig
boolean

Status sobre o uso das configurações padrões estabelecidas

Example:

true

liberateAccess
boolean

Liberar acesso ao sistema ao colaborador

Example:

true

sendAccessEmail
boolean

Enviar acesso ao sistema por EMAIL ao colaborador

Example:

true

sendAccessSMS
boolean

Enviar acesso ao sistema por SMS ao colaborador

Example:

true

requestFacialRegistration
boolean

Solicitar cadastro da Facial ao colaborador

Example:

true

isDraft
boolean

Flag para identificar se é um rascunho

Example:

false

step
enum<string>
default:PREFERENCIA

Etapa de cadastro do colaborador

Available options:
DADOS,
COMPLEMENTO,
ALOCACAO,
PREFERENCIA,
DEFINICOES,
ACESSO,
CONCLUIDO

Response

Atualizado com sucesso

status
boolean
required

Status da operação

Example:

true

mensagem
string

Mensagem de retorno

Example:

"OK"