ZapyFlow/Documentação da APIopenapi.json

WhatsApp Templates

Modelos aprovados

GET/api/ai-agents/{id}/channel-template-options

Escopo exigido: agents.read

ParâmetroOndeObrigatório
categoryquerynão
idpathsim
bash
curl "https://api.zapyflow.com.br/api/ai-agents/{id}/channel-template-options" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK

POST/api/channels/{channelId}/whatsapp-templates

Escopo exigido: whatsapp_templates.write

ParâmetroOndeObrigatório
channelIdpathsim

Corpo da requisição

CampoTipoObrigatórioRestrições
namestringsimmin 1, max 512
category"MARKETING" | "UTILITY" | "AUTHENTICATION"sim—
languagestringsim—
componentsobject | object | object | object | object | object | object[]sim≥ 1 items, ≤ 4 items
bash
curl -X POST "https://api.zapyflow.com.br/api/channels/{channelId}/whatsapp-templates" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'
Respostas
  • 201 — Criado
  • 400 — Requisição malformada

POST/api/channels/{channelId}/whatsapp-templates/media-handle

Escopo exigido: whatsapp_templates.write

ParâmetroOndeObrigatório
channelIdpathsim
bash
curl -X POST "https://api.zapyflow.com.br/api/channels/{channelId}/whatsapp-templates/media-handle" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK
  • 400 — Requisição malformada

POST/api/channels/{channelId}/whatsapp-templates/sync

Escopo exigido: whatsapp_templates.write

ParâmetroOndeObrigatório
channelIdpathsim
bash
curl -X POST "https://api.zapyflow.com.br/api/channels/{channelId}/whatsapp-templates/sync" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK
  • 409 — Conflito com o estado atual

GET/api/whatsapp-templates

Escopo exigido: whatsapp_templates.read

ParâmetroOndeObrigatório
channelIdquerynão
categoryquerynão
statusquerynão
languagequerynão
searchquerynão
pagequerynão
limitquerynão
bash
curl "https://api.zapyflow.com.br/api/whatsapp-templates" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK

GET/api/whatsapp-templates/{id}

Escopo exigido: whatsapp_templates.read

ParâmetroOndeObrigatório
idpathsim
bash
curl "https://api.zapyflow.com.br/api/whatsapp-templates/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK
  • 404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

DELETE/api/whatsapp-templates/{id}

Escopo exigido: whatsapp_templates.write

ParâmetroOndeObrigatório
idpathsim
bash
curl -X DELETE "https://api.zapyflow.com.br/api/whatsapp-templates/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 204 — Sem conteúdo

GET/api/whatsapp-templates/stats

Escopo exigido: analytics.read

ParâmetroOndeObrigatório
channelIdquerynão
bash
curl "https://api.zapyflow.com.br/api/whatsapp-templates/stats" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respostas
  • 200 — OK