➕ Criar Usuário

📖 Descrição

Cria um novo usuário vinculado à empresa.

🎯 Detalhes e Regras de Uso

Os campos obrigatórios são:

name — nome completo do usuário

email — e-mail corporativo válido

role — tipo de usuário (admin ou manager)

O campo phone é opcional, mas se fornecido deve ser um número de celular válido, pois poderá ser utilizado para o envio do código de autenticação via SMS durante o login.

👤 Tipos de Usuário

Somente dois tipos de usuário podem ser criados:

1. Admin

Possui acesso total a todas as pesquisas e módulos.

Pode gerenciar qualquer objetivo e tarefa no plano de ação, mesmo que não seja o responsável direto.

Tem acesso às pesquisas de onboarding e offboarding (caso disponíveis na empresa).

2. Manager

Possui acesso apenas às pesquisas atribuídas a ele.

Pode ter restrições de visualização nos resultados das pesquisas.

Não tem acesso às pesquisas de onboarding e offboarding.

No plano de ação (pda), o nível de acesso pode variar entre admin e manager:

admin: pode gerenciar todos os itens.

manager: pode gerenciar apenas os itens atribuídos a si e criar novos itens próprios.

🔐 Permissões de Acesso

Durante a criação do usuário, é possível enviar uma lista de permissões personalizadas.

Se o usuário for do tipo admin, não é necessário enviar permissões — o acesso é total por padrão.

Para usuários manager, cada permissão deve conter (campaign_accesses):

campaign_id — identificador da pesquisa à qual a permissão se refere.

Opcionalmente, restrições podem ser aplicadas de duas formas:

Por perfil — informe o identificador do perfil no campo profile.

Por recortes (filtros personalizados) — envie um array fields, onde cada item deve conter:

filter: nome do filtro aplicado (único no array).

values: array com os nomes dos recortes permitidos (únicos para cada filtro).

🆔 UUID de Retorno

O endpoint retorna o UUID do usuário criado.
Esse identificador deve ser utilizado para atualizar ou excluir o usuário posteriormente.

Exemplos de uso:

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Bodyapplication/jsonNecessário

Exemplo

{
    "name": "string",
    "email": "user@example.com",
    "phone": "stringstrin",
    "role": "admin",
    "pda": "admin",
    "campaign_accesses": [
        {
            "campaign_id": "78614b6c-fe7c-41e2-8e25-c9b3a3c91904",
            "profile": "94c81434-9201-4efa-9ba1-e5d7d2817353",
            "fields": [
                {
                    "filter": "string",
                    "values": [
                        "string"
                    ]
                }
            ]
        }
    ]
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200Sucesso

application/json

Bodyapplication/json

Exemplo

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "email": "string",
    "phone": "stringstrings",
    "role": "admin",
    "pda": "admin",
    "language": "pt_br",
    "onboarding": true,
    "offboarding": true,
    "campaign_accesses": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "campaign_id": "78614b6c-fe7c-41e2-8e25-c9b3a3c91904",
            "type": "boosterh",
            "subtype": "string",
            "fields": [
                {
                    "filter": "string",
                    "values": "string"
                }
            ]
        }
    ],
    "created_at": "2019-08-24T14:15:22.123Z",
    "updated_at": "2019-08-24T14:15:22.123Z"
}

🟠400Erro Padrão

🟠401Não Autenticado

🟠403Não Autorizado

🟠404Não Encontrado

🟠422Entidade Improcessável

📖 Descrição#

🎯 Detalhes e Regras de Uso#

👤 Tipos de Usuário#

1. Admin#

2. Manager#

🔐 Permissões de Acesso#

🆔 UUID de Retorno#