Documentação da API

POST /api/v1/leads — Body (JSON)

• name (obrigatório)
• email, phone, document (opcionais)
• status — new | contacted | qualified | proposal | won | lost (default: new)
• score — 0–100 (opcional)
• value — número (opcional)
• pipeline_id, stage_id — UUIDs (opcionais; se omitidos, usa pipeline/etapa padrão)
• custom_fields — objeto opcional: chaves são os keys dos campos personalizados (CRM → Configurações → Campos). Valores podem ser string, número, boolean ou array de strings (multi_select). Datas no formato YYYY-MM-DD.

curl -X POST "https://boxify.com.br/api/v1/leads" \
  -H "Authorization: Bearer bx_seu_token" \
  -H "Content-Type: application/json" \
  -d '{"name":"João Silva","email":"joao@email.com","phone":"11999999999"}'

Exemplo com custom_fields

{
  "name": "Nome de Teste",
  "email": "email@exemplo.com",
  "phone": "(31) 98902-1479",
  "document": "18.384.262/0001-62",
  "status": "new",
  "score": 100,
  "value": 10000,
  "pipeline_id": "9abf49fa-1b05-4be7-8ec5-76646e4df53d",
  "stage_id": "a27eca03-6cf7-47e6-91ba-f218b9da34d7",
  "custom_fields": {
    "datadaatualizacao": "2026-03-04",
    "datadalista": "2026-03-01",
    "datadeconclusao": "2026-03-30",
    "datadenascimento": "1994-09-28",
    "observacoes": "Observações",
    "responsavel": "Responsável",
    "statusboavista": true,
    "statuscenprotsp": true,
    "statusdoprocesso": "100% baixado",
    "statusspc": true,
    "tipodeprocesso": ["individual"]
  }
}

GET /api/v1/leads — Query e resposta

Lista leads do pipeline. Se pipeline_id não for enviado, usa o pipeline padrão da organização. Cada lead na resposta inclui custom_fields (objeto chave → valor).

• pipeline_id (opcional) — UUID do pipeline
• limit (opcional) — 1–500, default 100

curl -X GET "https://boxify.com.br/api/v1/leads?pipeline_id=9abf49fa-1b05-4be7-8ec5-76646e4df53d&limit=50" \
  -H "Authorization: Bearer bx_seu_token"

Resposta (200):

{
  "ok": true,
  "pipeline_id": "9abf49fa-1b05-4be7-8ec5-76646e4df53d",
  "leads": [
    {
      "id": "uuid",
      "name": "Nome de Teste",
      "email": "email@exemplo.com",
      "phone": "(31) 98902-1479",
      "document": "18.384.262/0001-62",
      "status": "new",
      "score": 100,
      "value": 10000,
      "pipeline_id": "...",
      "stage_id": "...",
      "created_at": "...",
      "updated_at": "...",
      "custom_fields": {
        "datadaatualizacao": "2026-03-04",
        "datadenascimento": "1994-09-28",
        "observacoes": "Observações",
        "tipodeprocesso": ["individual"]
      }
    }
  ],
  "org_id": "uuid"
}

POST /api/v1/ingest — Body e Query

Body: qualquer JSON (até 512 KB). Query: ?source= opcional (default: api).

curl -X POST "https://boxify.com.br/api/v1/ingest?source=meu_sistema" \
  -H "Authorization: Bearer bx_seu_token" \
  -H "Content-Type: application/json" \
  -d '{"evento":"clique","pagina":"/produto"}'

Power CRM — Query params

• states: q (busca), limit (máx. 1000)
• cities: q, uf, state_id, limit
• brands: q, limit
• models: q, brand_id, year, limit

Power CRM precisa estar conectado na organização (integrações). Caso contrário, retorna 404.

GET /api/crm/kanban — Query params

• pipelineId — UUID do pipeline (opcional; se omitido, usa o pipeline padrão)
• search — busca em nome, email e telefone
• status — new | contacted | qualified | proposal | won | lost
• source — filtro por origem do lead

Resposta: { pipeline, stages, leads }. Sem pipeline: pipeline: null, stages: [], leads: [].

POST /api/embed/chat — Body (JSON)

agentId (obrigatório), messages (array de { role, content } obrigatório). Opcionais: sessionId, contactName, contactPhone, contactEmail (para criar/associar lead).