We use cookies to improve your experience, analyze site traffic and measure how our Google ads perform. By clicking "Accept", you consent to analytics and advertising cookies. See our Privacy Policy for details.

Happy Thanksgiving - 15% off every paid plan Use code THANKYOU at checkout. Ends 30 November.See plans

API de Captura de Leads

Crea y gestiona formularios de captura de leads, recopila envios de lectores desde tus publicaciones y exporta datos de leads como CSV.

On this page

API de Captura de Leads

La API de Captura de Leads te permite crear formularios que aparecen dentro de tus publicaciones de flipbook para recopilar informacion de los lectores. Puedes configurar los campos del formulario, las condiciones de activacion y el estilo. Los leads capturados se almacenan y estan disponibles para listado, busqueda y exportacion CSV.

URL base: https://api.zenflip.io/v1/leads

Capturar un Lead (Publico)

Envia un lead desde el visor de la publicacion. Este es un endpoint publico --- no se requiere autenticacion. Es llamado por el visor integrado cuando un lector completa un formulario de captura de leads.

` POST /leads/capture/:pubId `

Limite de tasa: 10 envios por minuto por direccion IP.

Parametros de Ruta

Parametro

Tipo

Descripcion

pubId

string

UUID de la publicacion

Cuerpo de la Solicitud

Campo

Tipo

Requerido

Descripcion

email

string

Si

Direccion de email del lead

name

string

No

Nombre completo

company

string

No

Nombre de la empresa u organizacion

phone

string

No

Numero de telefono

customFields

object

No

Pares clave-valor para campos personalizados del formulario

sourcePage

integer

No

Numero de pagina donde se activo el formulario

triggerType

string

No

Como aparecio el formulario: page, exit, timer, scroll

Ejemplo de Solicitud

`bash curl -X POST "https://api.zenflip.io/v1/leads/capture/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \ -H "Content-Type: application/json" \ -d '{ "email": "jane@example.com", "name": "Jane Doe", "company": "Acme Inc.", "phone": "+1-555-0100", "customFields": { "jobTitle": "Product Manager", "department": "Marketing" }, "sourcePage": 3, "triggerType": "page" }' `

Ejemplo de Respuesta

`json { "data": { "id": "d4e5f6a7-b8c9-0123-def0-234567890123", "email": "jane@example.com", "name": "Jane Doe", "company": "Acme Inc.", "phone": "+1-555-0100", "customFields": { "jobTitle": "Product Manager", "department": "Marketing" }, "sourcePage": 3, "triggerType": "page", "capturedAt": "2026-02-20T15:30:00.000Z" } } `

Listar Leads

Obtiene una lista paginada de todos los leads capturados de tu organizacion.

` GET /leads `

Parametros de Consulta

Parametro

Tipo

Requerido

Descripcion

pubId

string

No

Filtrar por ID de publicacion

page

integer

No

Numero de pagina (por defecto: 1)

limit

integer

No

Elementos por pagina (por defecto: 20)

search

string

No

Buscar por email o nombre

Ejemplo de Solicitud

`bash curl "https://api.zenflip.io/v1/leads?pubId=a1b2c3d4...&page=1&limit=20" \ -H "Authorization: Bearer YOUR_TOKEN" `

Ejemplo de Respuesta

`json { "data": [ { "id": "d4e5f6a7-b8c9-0123-def0-234567890123", "publicationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "email": "jane@example.com", "name": "Jane Doe", "company": "Acme Inc.", "phone": "+1-555-0100", "customFields": { "jobTitle": "Product Manager" }, "sourcePage": 3, "triggerType": "page", "capturedAt": "2026-02-20T15:30:00.000Z" } ], "meta": { "total": 142, "page": 1, "limit": 20, "totalPages": 8 } } `

Exportar Leads como CSV

Exporta todos los leads de tu organizacion (o de una publicacion especifica) como un archivo CSV.

` GET /leads/export `

Parametros de Consulta

Parametro

Tipo

Requerido

Descripcion

pubId

string

No

Filtrar por ID de publicacion

Ejemplo de Solicitud

`bash curl "https://api.zenflip.io/v1/leads/export?pubId=a1b2c3d4..." \ -H "Authorization: Bearer YOUR_TOKEN" `

Ejemplo de Respuesta

`json { "data": "email,name,company,phone,source_page,trigger_type,captured_at\njane@example.com,Jane Doe,Acme Inc.,+1-555-0100,3,page,2026-02-20T15:30:00.000Z\n" } `

Formularios de Captura de Leads

Los formularios de captura de leads definen los campos, las condiciones de activacion y el estilo de los formularios mostrados a los lectores dentro de tus publicaciones.

Listar Formularios de una Publicacion

` GET /leads/forms/:pubId `

Ejemplo de Solicitud

`bash curl "https://api.zenflip.io/v1/leads/forms/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \ -H "Authorization: Bearer YOUR_TOKEN" `

Ejemplo de Respuesta

`json { "data": [ { "id": "e5f6a7b8-c9d0-1234-ef01-345678901234", "publicationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "title": "Download gated form", "description": "Enter your details to continue reading", "fields": [ { "name": "email", "type": "email", "label": "Email", "required": true }, { "name": "name", "type": "text", "label": "Full Name", "required": false }, { "name": "company", "type": "text", "label": "Company", "required": false } ], "trigger": { "type": "page", "page": 3 }, "styling": { "backgroundColor": "#ffffff", "buttonColor": "#3b82f6" }, "isActive": true, "createdAt": "2026-02-10T09:00:00.000Z", "updatedAt": "2026-02-10T09:00:00.000Z" } ] } `

Crear un Formulario de Captura de Leads

` POST /leads/forms/:pubId `

Rol requerido: editor o superior. Funcionalidad del plan requerida: leadCapture.

Cuerpo de la Solicitud

Campo

Tipo

Requerido

Descripcion

title

string

Si

Titulo del formulario (max 200 caracteres)

description

string

No

Descripcion mostrada sobre el formulario

fields

array

Si

Array de definiciones de campos (ver abajo)

trigger

object

Si

Configuracion de activacion (ver abajo)

styling

object

No

Opciones de estilo personalizado

Objeto de Definicion de Campo

Propiedad

Tipo

Descripcion

name

string

Identificador del campo (usado como clave en los envios)

type

string

Tipo de campo: email, text, tel, select, textarea

label

string

Etiqueta de visualizacion del campo

required

boolean

Si el campo es obligatorio

options

array

Opciones para campos select (array de strings)

Objeto de Configuracion de Activacion

Propiedad

Tipo

Descripcion

type

string

Tipo de activacion: page, exit, timer, scroll

page

integer

Numero de pagina (para activacion page)

delay

integer

Segundos de espera (para activacion timer)

percent

integer

Porcentaje de desplazamiento (para activacion scroll)

Ejemplo de Solicitud

`bash curl -X POST "https://api.zenflip.io/v1/leads/forms/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "title": "Get the full report", "description": "Enter your email to unlock all pages", "fields": [ { "name": "email", "type": "email", "label": "Work Email", "required": true }, { "name": "name", "type": "text", "label": "Full Name", "required": true }, { "name": "company", "type": "text", "label": "Company", "required": false } ], "trigger": { "type": "page", "page": 5 }, "styling": { "backgroundColor": "#ffffff", "buttonColor": "#4F46E5", "buttonText": "Unlock Report" } }' `

Actualizar un Formulario de Captura de Leads

` PATCH /leads/forms/:formId `

Rol requerido: editor o superior.

Todos los campos son opcionales. Solo incluye los campos que deseas cambiar.

Campo

Tipo

Descripcion

title

string

Titulo del formulario

description

string

Descripcion del formulario

fields

array

Definiciones de campos actualizadas

trigger

object

Configuracion de activacion actualizada

styling

object

Opciones de estilo actualizadas

isActive

boolean

Habilitar o deshabilitar el formulario

Eliminar un Formulario de Captura de Leads

` DELETE /leads/forms/:formId `

Rol requerido: editor o superior.

`bash curl -X DELETE "https://api.zenflip.io/v1/leads/forms/e5f6a7b8-c9d0-1234-ef01-345678901234" \ -H "Authorization: Bearer YOUR_TOKEN" `

Respuesta

`json { "message": "Lead capture form deleted" } `

Obtener Formularios Activos (Publico)

Obtiene solo los formularios de captura de leads activos de una publicacion. Este es un endpoint publico utilizado por el visor para saber que formularios mostrar.

` GET /leads/forms/public/:pubId `

No se requiere autenticacion. Devuelve solo los formularios donde isActive es true.

← Previous
API de Analiticas
Next →
API de Publicaciones