➕ Criar Filtro

🧪 Servidor de Sandbox

https://scenic-tokyo-3bje4ahyb4rd.on-vapor.com/api

POST

/v1/filters

📖 Descrição

Cria um novo filtro para a empresa.

⚠️ Importante

Filtros is_required=true tornam-se obrigatórios para todos os funcionários

A key deve ser única por empresa

default_value é usado quando employee não especifica valor

🎯 Exemplo Prático

Criando filtro obrigatório de Departamento:

{
  "key": "departamento",
  "default_value": "Não informado"
}

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Parâmetros Header

Parâmetros Bodyapplication/json

Exemplo

{
    "key": "departamento",
    "default_value": "TI",
    "is_avd": true,
    "is_campaign": true
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://scenic-tokyo-3bje4ahyb4rd.on-vapor.com/api/v1/filters' \
--header 'Resource-Id: 9c73a4aa-8094-4241-ad05-658436f471fe' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "key": "departamento",
    "default_value": "TI",
    "is_avd": true,
    "is_campaign": true
}'

Respostas

🟢201Criado

application/json

✅ Filtro criado com sucesso

Bodyapplication/json

Exemplo

{
    "data": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "key": "string",
        "default_value": "string",
        "is_required": true,
        "is_filterable": true,
        "is_default": true,
        "language": "string",
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z"
    }
}

🟠422Erro de Parâmetro

Modificado em 2026-02-18 17:37:52