Leads
Captura de leads
GET/api/leads
Listar leads do time
Escopo exigido: leads.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
page | query | não |
limit | query | não |
aiAgentId | query | não |
phone | query | não |
search | query | não |
dateFrom | query | não |
dateTo | query | não |
bash
curl "https://api.zapyflow.com.br/api/leads" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK
POST/api/leads
Criar lead manual
Escopo exigido: leads.write
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
name | string | não | max 100 |
email | string | não | — |
address | string | não | max 200 |
tags | string[] | não | — |
data | object | não | — |
aiAgentId | string | sim | — |
phone | string | sim | min 8, max 30 |
bash
curl -X POST "https://api.zapyflow.com.br/api/leads" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
200— OK400— Requisição malformada404— Não encontrado — também é a resposta quando o recurso é de outro workspace409— Conflito com o estado atual
GET/api/leads/{id}
Detalhes de um lead
Escopo exigido: leads.read
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl "https://api.zapyflow.com.br/api/leads/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace
PATCH/api/leads/{id}
Atualizar lead
Escopo exigido: leads.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
Corpo da requisição
| Campo | Tipo | Obrigatório | Restrições |
|---|---|---|---|
name | string | não | max 100 |
email | string | não | — |
address | string | não | max 200 |
tags | string[] | não | — |
data | object | não | — |
bash
curl -X PATCH "https://api.zapyflow.com.br/api/leads/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace
DELETE/api/leads/{id}
Deletar lead
Escopo exigido: leads.write
| Parâmetro | Onde | Obrigatório |
|---|---|---|
id | path | sim |
bash
curl -X DELETE "https://api.zapyflow.com.br/api/leads/{id}" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK404— Não encontrado — também é a resposta quando o recurso é de outro workspace
GET/api/leads/export
Exportar leads para CSV
Escopo exigido: leads.export
| Parâmetro | Onde | Obrigatório |
|---|---|---|
aiAgentId | query | não |
from | query | não |
to | query | não |
acknowledged | query | não |
bash
curl "https://api.zapyflow.com.br/api/leads/export" \
-H "Authorization: Bearer $ZAPYFLOW_API_KEY"Respostas
200— OK400— Requisição malformada428— Exige um reconhecimento explícito