ZapyFlow/Documentación de la APIopenapi.json

Leads

Captura de leads

GET/api/leads

Listar los leads del equipo

Ámbito requerido: leads.read

ParámetroDóndeObligatorio
pagequeryno
limitqueryno
aiAgentIdqueryno
phonequeryno
searchqueryno
dateFromqueryno
dateToqueryno
bash
curl "https://api.zapyflow.com.br/api/leads" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK

POST/api/leads

Crear un lead manualmente

Ámbito requerido: leads.write

Cuerpo de la petición

CampoTipoObligatorioRestricciones
namestringnomax 100
emailstringno—
addressstringnomax 200
tagsstring[]no—
dataobjectno—
aiAgentIdstringsí—
phonestringsí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 '{ ... }'
Respuestas
  • 200 — OK
  • 400 — Petición malformada
  • 404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace
  • 409 — Conflicto con el estado actual

GET/api/leads/{id}

Detalles de un lead

Ámbito requerido: leads.read

ParámetroDóndeObligatorio
idpathsí
bash
curl "https://api.zapyflow.com.br/api/leads/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

PATCH/api/leads/{id}

Actualizar un lead

Ámbito requerido: leads.write

ParámetroDóndeObligatorio
idpathsí

Cuerpo de la petición

CampoTipoObligatorioRestricciones
namestringnomax 100
emailstringno—
addressstringnomax 200
tagsstring[]no—
dataobjectno—
bash
curl -X PATCH "https://api.zapyflow.com.br/api/leads/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'
Respuestas
  • 200 — OK
  • 404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

DELETE/api/leads/{id}

Eliminar un lead

Ámbito requerido: leads.write

ParámetroDóndeObligatorio
idpathsí
bash
curl -X DELETE "https://api.zapyflow.com.br/api/leads/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

GET/api/leads/export

Exportar leads a CSV

Ámbito requerido: leads.export

ParámetroDóndeObligatorio
aiAgentIdqueryno
fromqueryno
toqueryno
acknowledgedqueryno
bash
curl "https://api.zapyflow.com.br/api/leads/export" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 400 — Petición malformada
  • 428 — Requiere un reconocimiento explícito