v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

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.

post/api/teams

Request body

namestring required

Primeiro nome do cliente adicionado na plataforma.

last_namestring required

Sobrenome do cliente adicionado na plataforma.

birthstring date

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

phonestring

Número de telefone com o 9 do cliente, caso seja um WhatsApp, o mesmo será utilizado para envio de alertas e notificações, incluindo quando uma assinatura for solicitada ao mesmo.

emailstring required

Endereço de e-mail do cliente adicionado na plataforma.

cpfstring

CPF do cliente devidamente formatado ou apenas números.

recive_emailstring

Se o usuário vai receber e-mails do sistema, 0 = Não recebe nada, 1 = Recebe tudo, 2 = Recebe somente solicitações.

recive_whatsappstring

Se o usuário vai receber mensagens de WhatsApp do sistema, 0 = Não recebe nada, 1 = Recebe tudo, 2 = Recebe somente solicitações.

cert_filestring binary

Arquivo do certificado digital PFX.

cert_passwordstring

Senha do certificado para validação, caso passe o certificado a senha é obrigatória.

passwordstring

Senha do seu colaborador para cadastro, caso não seja fornecida o sistema irá gerar uma senha temporária e enviará para ele por e-mail, caso passe uma senha, o sistema não vai avisa-lo sobre a criação da conta e não vai enviar alertas para o mesmo.

permissionsstring[] required

Obrigatório mesmo que um array vazio ['upload', 'edit', 'delete' 'protect', 'send_request', 'view_all_requests'].

role'admin' | 'user' | 'staff'

Cargo do usuário.

Response

200

Example response

{
  "data": {
    "id": 1,
    "name": "João",
    "last_name": "Silva",
    "email": "developer@exemplo.com",
    "phone": "11-99999-9999",
    "permissions": [
      "upload"
    ],
    "recive_email": 1,
    "recive_whatsapp": 1,
    "role": "admin",
    "status": "Active"
  }
}