Winx - API Integração
  1. Filters
Winx - API Integração
  • Raiz
    • Documentação de Integração
    • Companies
      • 📋 Listar Empresas
    • Filters
      • 📋 Listar Filtros
        GET
      • ➕ Criar Filtro
        POST
      • 🔍 Visualizar Filtro
        GET
      • ✏️ Atualizar Filtro
        PUT
      • 🗑️ Excluir Filtro
        DELETE
    • 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
      • ➕ Criar Usuário
      • 🔍 Visualizar Usuário
      • ✏️ Atualizar Usuário
      • 🗑️ Excluir Usuário
  • 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. Filters

✏️ Atualizar Filtro

PUT
/v1/filters/{filterId}

📖 Descrição#

Atualiza um filtro existente.

⚠️ Cuidados Importantes#

Alterar is_required para true afeta todos os funcionários existentes
Mudanças na key podem quebrar integrações existentes
Se remover default_value, funcionários sem valor específico ficarão vazios

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
{
    "key": "string",
    "default_value": "string",
    "is_required": true,
    "is_filterable": true
}

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/filters/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "key": "string",
    "default_value": "string",
    "is_required": true,
    "is_filterable": true
}'

Respostas

🟢200OK
✅ Filtro atualizado com sucesso
Esta resposta não possui corpo.
🟠422Erro de Parâmetro
Modificado em 2025-08-27 20:31:55
Página anterior
🔍 Visualizar Filtro
Próxima página
🗑️ Excluir Filtro
Built with