ZapyFlow/Documentação da APIopenapi.json

Contatos

Contatos do workspace

GET/api/contacts

Contatos do time: números distintos que já falaram com os bots

Escopo exigido: contacts.read

ParâmetroOndeObrigatório
searchquerynão
filterquerynão
pagequerynão
limitquerynão
bash
curl "https://api.zapyflow.com.br/api/contacts" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK
  • 403 — Proibido, ou a chave não tem este escopo

GET/api/contacts/{phone}

Detalhe do contato: conversas, mensagens recentes e tags

Escopo exigido: contacts.read

ParâmetroOndeObrigatório
phonepathsim
bash
curl "https://api.zapyflow.com.br/api/contacts/{phone}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK
  • 403 — Proibido, ou a chave não tem este escopo
  • 404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

PATCH/api/contacts/{phone}/tags

Substituir as etiquetas do contato

Escopo exigido: contacts.write

ParâmetroOndeObrigatório
phonepathsim

Corpo da requisição

CampoTipoObrigatórioRestrições
tagsstring | object[]sim≤ 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 '{ ... }'
Respostas
  • 200 — OK
  • 403 — Proibido, ou a chave não tem este escopo
  • 404 — Não encontrado — também é a resposta quando o recurso é de outro workspace
  • 422 — Entendido, mas recusado por uma regra

GET/api/contacts/export

Exportar contatos para CSV (máx. 10000 linhas)

Escopo exigido: contacts.export

ParâmetroOndeObrigatório
searchquerynão
filterquerynão
acknowledgedquerynão
bash
curl "https://api.zapyflow.com.br/api/contacts/export" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK
  • 403 — Proibido, ou a chave não tem este escopo
  • 428 — Exige um reconhecimento explícito

POST/api/contacts/import

Importa contatos de um CSV, sem exigir conversa anterior

Escopo exigido: contacts.import

Corpo da requisição

CampoTipoObrigatórioRestrições
csvstringsimmin 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 '{ ... }'
Respostas
  • 200 — OK
  • 400 — Requisição malformada
  • 403 — Proibido, ou a chave não tem este escopo

GET/api/contacts/tags

As etiquetas do time, com a cor de cada uma

Escopo exigido: contacts.read

bash
curl "https://api.zapyflow.com.br/api/contacts/tags" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK
  • 403 — Proibido, ou a chave não tem este escopo