Colaboradores

Criação de um Colaborador

Este endpoint é utilizado para criar um novo colaborador no sistema. Os dados necessários para a criação do colaborador devem ser fornecidos no corpo da requisição. Os campos incluem:

  • companyId: string (ID da empresa) *
  • documentNumber: string (CPF do colaborador) *
  • email: string
  • externalId: string (ID externo para identificação)
  • invitationDate: string (Data de envio do convite)
  • name: string *
  • phoneNumber: string

[*] Campos obrigatórios

URL: /employees
Método: POST
Descrição: Cria um documento de Colaborador

ATENÇÃO: O parâmetro invitationDate, caso seja enviado, irá agendar a data de envio do convite do colaborador. Caso não seja enviado, o envio será feito imediatamente após a criação do documento."

Headers:

  • Content-Type: 'application/json'
  • x-flash-auth: <chave_api>

Corpo da Requisição:

{
   "companyId": string,
   "documentNumber": string,
   "email": string,
   "externalId": string,
   "invitationDate": string (date-time),
   "name": string,
   "phoneNumber": string
 }
plain