ZapyFlow/Documentación de la APIopenapi.json

WhatsApp Templates

Plantillas aprobadas

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

Ámbito requerido: agents.read

ParámetroDóndeObligatorio
categoryqueryno
idpathsí
bash
curl "https://api.zapyflow.com.br/api/ai-agents/{id}/channel-template-options" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK

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

Ámbito requerido: whatsapp_templates.write

ParámetroDóndeObligatorio
channelIdpathsí

Cuerpo de la petición

CampoTipoObligatorioRestricciones
namestringsímin 1, max 512
category"MARKETING" | "UTILITY" | "AUTHENTICATION"sí—
languagestringsí—
componentsobject | object | object | object | object | object | object[]sí≥ 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 '{ ... }'
Respuestas
  • 201 — Creado
  • 400 — Petición malformada

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

Ámbito requerido: whatsapp_templates.write

ParámetroDóndeObligatorio
channelIdpathsí
bash
curl -X POST "https://api.zapyflow.com.br/api/channels/{channelId}/whatsapp-templates/media-handle" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 400 — Petición malformada

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

Ámbito requerido: whatsapp_templates.write

ParámetroDóndeObligatorio
channelIdpathsí
bash
curl -X POST "https://api.zapyflow.com.br/api/channels/{channelId}/whatsapp-templates/sync" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK
  • 409 — Conflicto con el estado actual

GET/api/whatsapp-templates

Ámbito requerido: whatsapp_templates.read

ParámetroDóndeObligatorio
channelIdqueryno
categoryqueryno
statusqueryno
languagequeryno
searchqueryno
pagequeryno
limitqueryno
bash
curl "https://api.zapyflow.com.br/api/whatsapp-templates" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK

GET/api/whatsapp-templates/{id}

Ámbito requerido: whatsapp_templates.read

ParámetroDóndeObligatorio
idpathsí
bash
curl "https://api.zapyflow.com.br/api/whatsapp-templates/{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

DELETE/api/whatsapp-templates/{id}

Ámbito requerido: whatsapp_templates.write

ParámetroDóndeObligatorio
idpathsí
bash
curl -X DELETE "https://api.zapyflow.com.br/api/whatsapp-templates/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 204 — Sin contenido

GET/api/whatsapp-templates/stats

Ámbito requerido: analytics.read

ParámetroDóndeObligatorio
channelIdqueryno
bash
curl "https://api.zapyflow.com.br/api/whatsapp-templates/stats" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"
Respuestas
  • 200 — OK