➕ Criar Permissão

📖 Descrição

Cria uma nova permissão para um usuário vinculado à empresa.

🎯 Detalhes e Regras de Uso

Os campos obrigatórios são:

campaign_id — identificador da pesquisa para qual se deseja liberar a permissão

Os campos profile e fields são opcionais. Se nenhum dos dois campos forem fornecidos o usuário terá acesso completo a pesquisa.
Não é possível criar uma permissão para um usuário do tipo admin, já que o usuário terá acesso completo a todas as pesquisas.

🔐 Permissões de Acesso

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 da permissão criada.
Esse identificador deve ser utilizado para atualizar ou excluir a permissão 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 de Caminho

Parâmetros Bodyapplication/jsonNecessário

Exemplo

{
    "campaign_id": "78614b6c-fe7c-41e2-8e25-c9b3a3c91904",
    "fields": [
        {
            "filter": "string",
            "values": [
                "string"
            ]
        }
    ],
    "profile": "94c81434-9201-4efa-9ba1-e5d7d2817353"
}

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",
    "campaign_id": "78614b6c-fe7c-41e2-8e25-c9b3a3c91904",
    "type": "boosterh",
    "subtype": "string",
    "fields": [
        {
            "filter": "string",
            "values": "string"
        }
    ]
}

🟠400Erro Padrão

🟠401Não Autenticado

🟠403Não Autorizado

🟠404Não Encontrado

🟠422Entidade Improcessável

📖 Descrição#

🎯 Detalhes e Regras de Uso#

🔐 Permissões de Acesso#