ZapyFlow/Documentación de la APIopenapi.json

Contatos

Contactos del workspace

GET/api/contacts

Contactos del equipo: números distintos que ya hablaron con los agentes

Ámbito requerido: contacts.read

ParámetroDóndeObligatorio
searchqueryno
filterqueryno
pagequeryno
limitqueryno
bash
curl "https://api.zapyflow.com.br/api/contacts" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 403 — Prohibido, o la clave no tiene este ámbito

GET/api/contacts/{phone}

Detalle del contacto: conversaciones, mensajes recientes y etiquetas

Ámbito requerido: contacts.read

ParámetroDóndeObligatorio
phonepathsí
bash
curl "https://api.zapyflow.com.br/api/contacts/{phone}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 403 — Prohibido, o la clave no tiene este ámbito
  • 404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

PATCH/api/contacts/{phone}/tags

Reemplazar las etiquetas del contacto

Ámbito requerido: contacts.write

ParámetroDóndeObligatorio
phonepathsí

Cuerpo de la petición

CampoTipoObligatorioRestricciones
tagsstring | object[]sí≤ 20 items
bash
curl -X PATCH "https://api.zapyflow.com.br/api/contacts/{phone}/tags" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'
Respuestas
  • 200 — OK
  • 403 — Prohibido, o la clave no tiene este ámbito
  • 404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace
  • 422 — Entendido, pero rechazado por una regla

GET/api/contacts/export

Exportar contactos a CSV (máx. 10.000 filas)

Ámbito requerido: contacts.export

ParámetroDóndeObligatorio
searchqueryno
filterqueryno
acknowledgedqueryno
bash
curl "https://api.zapyflow.com.br/api/contacts/export" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 403 — Prohibido, o la clave no tiene este ámbito
  • 428 — Requiere un reconocimiento explícito

POST/api/contacts/import

Importa contactos desde un CSV, sin exigir conversación previa

Ámbito requerido: contacts.import

Cuerpo de la petición

CampoTipoObligatorioRestricciones
csvstringsímin 1, max 5242880
bash
curl -X POST "https://api.zapyflow.com.br/api/contacts/import" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'
Respuestas
  • 200 — OK
  • 400 — Petición malformada
  • 403 — Prohibido, o la clave no tiene este ámbito

GET/api/contacts/tags

Las etiquetas del equipo, cada una con su color

Ámbito requerido: contacts.read

bash
curl "https://api.zapyflow.com.br/api/contacts/tags" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 403 — Prohibido, o la clave no tiene este ámbito