🎯 Leads

Os Leads representam potenciais clientes, oportunidades ou contatos não convertidos que caíram no seu funil.

---

Listar Leads

Retorna uma lista paginada de leads.

GET /api/leads

Parâmetros de Query (Opcionais)

• page: Número da página (padrão: 1)
• pageSize: Quantidade de itens por página (padrão: 10)

Exemplo de Resposta (200 OK)

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "firstName": "Maria",
      "lastName": "Silva",
      "email": "maria@exemplo.com",
      "phone": "11988887777",
      "company": "Tech Corp",
      "status": "New",
      "sourceId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2026-07-11T10:00:00Z"
    }
  ],
  "totalCount": 150,
  "totalPages": 15,
  "currentPage": 1
}

---

Criar um Lead

Cria um novo Lead no CRM.

POST /api/leads

Corpo da Requisição

{
  "firstName": "João",
  "lastName": "Souza",
  "email": "joao@exemplo.com",
  "phone": "21999998888",
  "company": "Empresa XYZ",
  "sourceId": "uuid-da-origem",
  "notes": "Entrou em contato pelo formulário de orçamento"
}

Dica sobre o sourceId: Para obter as origens cadastradas na sua conta (como Site, WhatsApp, etc), consulte o endpoint GET /api/leadsources.

Exemplo de Resposta (201 Created)

Retorna o objeto do Lead recém-criado, incluindo o id.

---

Obter um Lead Específico

GET /api/leads/{id}

Retorna os dados completos do Lead, incluindo sua lista de Tags associadas.

---

Atualizar um Lead

PUT /api/leads/{id}

Atualiza os dados cadastrais do Lead. Envie no corpo da requisição os campos que deseja alterar (mesmo formato da criação).

---

Excluir um Lead (Soft Delete)

DELETE /api/leads/{id}

Move o Lead para a lixeira. Retorna 204 No Content em caso de sucesso.