Criar um colaborador

isCompany assume false (CPF). Campos específicos de colaborador não são mapeados pela API pública e são repassados com o nome interno.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Nome do colaborador

boolean

Padrão false

string
string
string

Telefone com DDD, só dígitos (10 ou 11) ou já mascarado. É gravado e devolvido mascarado. Formatos mascarados aceitos: (11) 97777-6666 (com espaço após o DDD), (11) 3333-4444 e 0800-123-4567. Sem o espaço, (11)97777-6666, a resposta é 400.

string

CPF. É gravado e devolvido mascarado (123.456.789-09); aceita só dígitos ou já mascarado.

string
dataBaking
object

Dados bancários: bank, bankAccountType, agency, account, accountVariation

dataPix
array of objects

Chaves PIX; no máximo uma com default igual a "true". Cada item exige key, description, default e remove. default e remove são strings ("true" ou "false"): um booleano JSON devolve 400. Um item em outro formato (por exemplo, {type, key}) faz a API responder 500 sem corpo.

dataPix
dataRate
object

Avaliação: deadline, quality, price, attendance (1 a 5)

dataLocality
object

Endereço: address, addressComplement, addressNumber, cep, city, idCity, codIBGE, country, district, state (obrigatórios exceto idCity e codIBGE)

string

Cargo (nome interno, sem validação)

integer

Id do cargo (nome interno, sem validação)

date

Data de nascimento (nome interno, sem validação)

date

Data de admissão (nome interno, sem validação)

date

Data de desligamento (nome interno, sem validação)

number

Salário bruto (nome interno, sem validação)

number

Valor hora inicial (nome interno, sem validação)

string

Observações (nome interno, sem validação)

sBenefits
array

Benefícios (nome interno, gravado como JSON)

sBenefits
integer

Usuário vinculado (nome interno, sem validação)

Headers
string
enum

Com o valor recordCreated, a resposta traz o registro criado em {meta, records}.

Allowed:
Responses

500

Erro interno. Sem corpo na resposta. Acontece, por exemplo, quando um item de dataPix está em formato diferente do documentado (como {type, key}).

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json