Winx - API Integração
  1. Permissions
Winx - API Integração
  • Raiz
    • Documentação de Integração
    • Companies
      • 📋 Listar Empresas
    • Filters
      • 📋 Listar Filtros
      • ➕ Criar Filtro
      • 🔍 Visualizar Filtro
      • ✏️ Atualizar Filtro
      • 🗑️ Excluir Filtro
    • Employees
      • 📋 Listar Funcionários
      • ➕ Criar Funcionário
      • 🔍 Visualizar Funcionário
      • ✏️ Atualizar Funcionário
      • 🗑️ Excluir Funcionário
    • Users
      • Permissions
        • 📋 Listar Permissões
          GET
        • ➕ Criar Permissão
          POST
        • 🔍 Visualizar Permissão
          GET
        • 🗑️ Excluir Permissão
          DELETE
      • Profile
        • 📋 Listar Perfis
        • ➕ Criar Perfil
        • 🔍 Visualizar Perfil
        • ✏️ Atualizar Perfil
        • 🗑️ Excluir Perfil
      • 📋 Listar Usuários
        GET
      • ➕ Criar Usuário
        POST
      • 🔍 Visualizar Usuário
        GET
      • ✏️ Atualizar Usuário
        PUT
      • 🗑️ Excluir Usuário
        DELETE
  • Esquemas
    • Schemas
      • UserCreate
      • User
      • CampaignAccess
      • UserCollection
      • PermissionCreate
      • PermissionUpdate
      • ProfileCreate
      • Profile
      • ProfileCollection
      • Company
      • Filter
      • FilterCreate
      • FilterUpdate
      • EmployeeField
      • PaginationLinks
      • PaginationMeta
      • ErrorResponse
      • ValidationErrorResponse
    • Response
      • Unauthorized
      • Forbidden
      • NotFound
      • ValidationError
  1. Permissions

➕ Criar Permissão

POST
/v1/users/{user}/permissions

📖 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:
1.
Por perfil — informe o identificador do perfil no campo profile.
2.
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",
    "profile": "94c81434-9201-4efa-9ba1-e5d7d2817353",
    "fields": [
        {
            "filter": "string",
            "values": [
                "string"
            ]
        }
    ]
}

Exemplos de Requisição

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://scenic-tokyo-3bje4ahyb4rd.on-vapor.com/api/v1/users//permissions' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "campaign_id": "78614b6c-fe7c-41e2-8e25-c9b3a3c91904",
    "profile": "94c81434-9201-4efa-9ba1-e5d7d2817353",
    "fields": [
        {
            "filter": "string",
            "values": [
                "string"
            ]
        }
    ]
}'

Respostas

🟢200Sucesso
application/json
Body

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
Modificado em 2025-12-05 14:44:24
Página anterior
📋 Listar Permissões
Próxima página
🔍 Visualizar Permissão
Built with