POST Create team user

Com este endpoint você pode criar contas de colaboradores, para que os mesmos possuam acesso ao sistema via front-end e possam utilizar a plataforma, assim como visualizar os dados submetidos via API.

Caso não queira fornecer acessos aos colaboradores, é possível manipular o sistema sem tais contas, executando todas as ações como administrador do sistema.

Atenção! Ao criar uma conta de colaborador, é possível avisá-lo ou não da criação. Caso você informe o parâmetro password, ele não será avisado da criação da conta nem receberá alertas do sistema (para uso WhiteLabel). Caso NÃO passe uma senha, o sistema vai gerar uma automaticamente e enviar para o e-mail do colaborador, portanto ele terá conhecimento da conta e uma forma de acessar a plataforma.

Regras:

  • permissions é obrigatório e precisa ter pelo menos um valor (um array vazio responde 422).
  • cpf aceita apenas números (um CPF formatado responde 422).
  • cert_file e signature como arquivo exigem multipart/form-data; o editor desta página não suporta esse formato.
  • Se o e-mail já existe em outra empresa, o usuário existente é apenas vinculado à sua empresa com o cargo e as permissões informados; nome, senha, certificado e assinatura enviados são ignorados e nenhum e-mail é enviado.
  • Sem role, o cargo padrão é staff.
  • A mensagem de sucesso é a mesma mesmo quando password foi informada (nesse caso nenhum e-mail é enviado).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Primeiro nome do colaborador.

string
required

Sobrenome do colaborador.

date

Data de nascimento do colaborador no formato ano-mês-dia. Exemplo: 1990-05-12.

string

Telefone com DDD e 9 (ex.: 11999999999). Usado para as notificações por WhatsApp, quando habilitadas.

string
required

E-mail do colaborador (identificador único da conta).

string

CPF válido, apenas números (ex.: 52998224725). Formatado é rejeitado.

integer
enum

Recebimento de e-mails: 0 = não recebe nada, 1 = recebe tudo, 2 = recebe somente solicitações.

Allowed:
integer
enum

Recebimento de mensagens de WhatsApp: 0 = não recebe nada, 1 = recebe tudo, 2 = recebe somente solicitações.

Allowed:
file

Arquivo do certificado digital (.pfx ou .p12). Enviar como arquivo em multipart/form-data; cert_password é obrigatória junto.

string

Senha do certificado. Obrigatória quando cert_file é enviado; senha errada responde 401.

string

Senha de acesso do colaborador. Se omitida, ele recebe um e-mail para criar a senha; se informada, nenhum e-mail é enviado (uso white label).

permissions
array of strings
required

Permissões do colaborador. Obrigatório, com pelo menos um valor.

permissions*
Allowed:
string
enum
Defaults to staff

Cargo do colaborador: admin, staff ou user. Padrão: staff.

Allowed:
file

Imagem da assinatura do colaborador: arquivo PNG ou JPG de até 5024 KB (multipart/form-data) ou string base64 (data URI ou base64 puro). Se omitida, a plataforma gera uma assinatura padrão a partir do nome.

Responses

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