Referencia (endpoints)

Formularios

Armar, editar, publicar y borrar tus formularios de WhatsApp, sus versiones y sus números, y leer sus respuestas y métricas.

Armar, editar, publicar y borrar tus formularios de WhatsApp, sus versiones y sus números, y leer sus respuestas y métricas.

Ver los modelos de formulario

GET /api/v1/forms/templates · Sirve para ver los modelos con los que puedes empezar un formulario de WhatsApp (uno en blanco y otros listos) y elegir la key que pides al crearlo.

Crear un formulario

POST /api/v1/forms · Úsalo para empezar un formulario de WhatsApp en uno de tus números oficiales, a partir de un modelo: queda como borrador y después le guardas su contenido.

Ver un formulario

GET /api/v1/forms/{id} · Sirve para ver una versión de un formulario con su contenido, lo que falta corregir antes de publicarla, sus versiones y sus números.

Editar un formulario

PUT /api/v1/forms/{id} · Úsalo para guardar el contenido de un borrador de formulario —sus pantallas y preguntas— y ver en la respuesta qué falta corregir antes de publicarlo.

Borrar un formulario

DELETE /api/v1/forms/{id} · Sirve para borrar un borrador de formulario que ya no vas a publicar. Un formulario publicado no se borra.

Crear una versión de un formulario

POST /api/v1/forms/{id}/versions · Úsalo para cambiar un formulario ya publicado: crea un borrador nuevo a partir de esa versión, que editas y publicas sin cambiar el form_id con el que lo mandas.

Publicar un formulario

POST /api/v1/forms/{id}/publish · Sirve para publicar una versión de un formulario, al momento, y dejarla lista para mandarla; en los otros números del formulario se publica en segundo plano.

Sincronizar un formulario

POST /api/v1/forms/{id}/sync · Úsalo para validar un formulario en Meta sin publicarlo y ver lo que Meta observa antes de publicarlo.

Ver los números de un formulario

GET /api/v1/forms/{id}/numbers · Sirve para ver en qué números oficiales está un formulario y cómo va su publicación en cada uno.

Sumar números a un formulario

POST /api/v1/forms/{id}/numbers · Úsalo para sumar un número oficial a un formulario y poder mandarlo también desde ahí; si ya está publicado, se publica en ese número enseguida.

Reintentar los números de un formulario

POST /api/v1/forms/{id}/numbers/retry · Sirve para volver a publicar un formulario en los números en los que falló o todavía no se publicó.

Sacar un número de un formulario

DELETE /api/v1/forms/{id}/numbers/{deviceId} · Úsalo para que un formulario deje de mandarse por uno de tus números. El número con el que lo creaste no se saca.

Ver las versiones de un formulario

GET /api/v1/forms/families/{familyId}/versions · Sirve para ver el historial de versiones de un formulario, cuál es la vigente y cuántas respuestas recibió cada una.

Ver la definición de un formulario

GET /api/v1/forms/families/{familyId}/definition · Úsalo para leer el contenido vigente de un formulario con su family_id (el de la versión publicada o, si no hay, el de la más nueva), sin buscar antes la versión.

Ver las respuestas de un formulario

GET /api/v1/forms/families/{familyId}/responses · Sirve para leer las respuestas de un formulario, de todas sus versiones, con filtros por fecha, versión o contacto; por ejemplo para exportarlas o revisarlas.

Ver una respuesta de un formulario

GET /api/v1/forms/families/{familyId}/responses/{runId} · Úsalo para ver una respuesta completa de un formulario: lo que contestó el contacto y lo que se hizo con esas respuestas.

Ver las métricas de un formulario

GET /api/v1/forms/families/{familyId}/metrics · Sirve para medir un formulario: cuántos se enviaron, cuántos se abrieron y cuántos se completaron, con sus porcentajes.

Esto es lo que se copia para tu IA

Cargando…