Winx - API Integração
  1. Users
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
        • ➕ Criar Permissão
        • 🔍 Visualizar Permissão
        • 🗑️ Excluir Permissão
      • 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. Users

✏️ Atualizar Usuário

PUT
/v1/users/{user}

📖 Descrição#

Atualiza um usuário vinculado à empresa.

🎯 Detalhes e Regras de Uso#

Na atulização não é possível atualizar a lista de permissões. Para isso verefique o CRUD de permissões.
Não é possível atualizar o usuário do tipo owner.
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.

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
{
    "name": "string",
    "email": "user@example.com",
    "phone": "stringstrin",
    "role": "admin",
    "pda": "admin"
}

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 PUT 'https://scenic-tokyo-3bje4ahyb4rd.on-vapor.com/api/v1/users/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "email": "user@example.com",
    "phone": "stringstrin",
    "role": "admin",
    "pda": "admin"
}'

Respostas

🟢200Sucesso
application/json
Body

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:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
}
🟠400Erro Padrão
🟠401Não Autenticado
🟠403Não Autorizado
🟠404Não Encontrado
🟠422Entidade Improcessável
Modificado em 2025-12-05 14:44:01
Página anterior
🔍 Visualizar Usuário
Próxima página
🗑️ Excluir Usuário
Built with