Lead-Capture-API

Erstellen und verwalten Sie Lead-Capture-Formulare, sammeln Sie Betrachter-Einreichungen aus Ihren Publikationen und exportieren Sie Lead-Daten als CSV.

On this page

Lead-Capture-API

Die Lead-Capture-API ermöglicht es Ihnen, Formulare zu erstellen, die innerhalb Ihrer Flipbook-Publikationen erscheinen, um Betrachterinformationen zu sammeln. Sie können Formularfelder, Auslösebedingungen und Styling konfigurieren. Erfasste Leads werden gespeichert und sind für Auflistung, Suche und CSV-Export verfügbar.

Basis-URL: https://api.zenflip.io/v1/leads

Lead erfassen (Öffentlich)

Einen Lead aus dem Publikations-Viewer einreichen. Dies ist ein öffentlicher Endpunkt --- eine Authentifizierung ist nicht erforderlich. Er wird vom eingebetteten Viewer aufgerufen, wenn ein Leser ein Lead-Capture-Formular ausfüllt.

` POST /leads/capture/:pubId `

Ratenlimit: 10 Einreichungen pro Minute pro IP-Adresse.

Pfadparameter

Parameter

Typ

Beschreibung

pubId

string

Publikations-UUID

Anfragekörper

Feld

Typ

Erforderlich

Beschreibung

email

string

Ja

E-Mail-Adresse des Leads

name

string

Nein

Vollständiger Name

company

string

Nein

Firmen- oder Organisationsname

phone

string

Nein

Telefonnummer

customFields

object

Nein

Schlüssel-Wert-Paare für benutzerdefinierte Formularfelder

sourcePage

integer

Nein

Seitennummer, auf der das Formular ausgelöst wurde

triggerType

string

Nein

Wie das Formular angezeigt wurde: page, exit, timer, scroll

Beispielanfrage

`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" }' `

Beispielantwort

`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" } } `

Leads auflisten

Rufen Sie eine paginierte Liste aller erfassten Leads Ihrer Organisation ab.

` GET /leads `

Abfrageparameter

Parameter

Typ

Erforderlich

Beschreibung

pubId

string

Nein

Nach Publikations-ID filtern

page

integer

Nein

Seitennummer (Standard: 1)

limit

integer

Nein

Einträge pro Seite (Standard: 20)

search

string

Nein

Nach E-Mail oder Name suchen

Beispielanfrage

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

Beispielantwort

`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 } } `

Leads als CSV exportieren

Exportieren Sie alle Leads Ihrer Organisation (oder einer bestimmten Publikation) als CSV-Datei.

` GET /leads/export `

Abfrageparameter

Parameter

Typ

Erforderlich

Beschreibung

pubId

string

Nein

Nach Publikations-ID filtern

Beispielanfrage

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

Beispielantwort

`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" } `

Lead-Capture-Formulare

Lead-Capture-Formulare definieren die Felder, Auslösebedingungen und das Styling für Formulare, die Betrachtern innerhalb Ihrer Publikationen angezeigt werden.

Formulare für eine Publikation auflisten

` GET /leads/forms/:pubId `

Beispielanfrage

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

Beispielantwort

`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" } ] } `

Ein Lead-Capture-Formular erstellen

` POST /leads/forms/:pubId `

Erforderliche Rolle: editor oder höher. Erforderliches Plan-Feature: leadCapture.

Anfragekörper

Feld

Typ

Erforderlich

Beschreibung

title

string

Ja

Formulartitel (max. 200 Zeichen)

description

string

Nein

Beschreibung, die über dem Formular angezeigt wird

fields

array

Ja

Array von Felddefinitionen (siehe unten)

trigger

object

Ja

Auslöser-Konfiguration (siehe unten)

styling

object

Nein

Benutzerdefinierte Styling-Optionen

Felddefinitionsobjekt

Eigenschaft

Typ

Beschreibung

name

string

Feldkennung (wird als Schlüssel in Einreichungen verwendet)

type

string

Feldtyp: email, text, tel, select, textarea

label

string

Anzeigebeschriftung des Feldes

required

boolean

Ob das Feld erforderlich ist

options

array

Optionen für select-Felder (Array von Strings)

Auslöser-Konfigurationsobjekt

Eigenschaft

Typ

Beschreibung

type

string

Auslösertyp: page, exit, timer, scroll

page

integer

Seitennummer (für page-Auslöser)

delay

integer

Wartezeit in Sekunden (für timer-Auslöser)

percent

integer

Scroll-Prozentsatz (für scroll-Auslöser)

Beispielanfrage

`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" } }' `

Ein Lead-Capture-Formular aktualisieren

` PATCH /leads/forms/:formId `

Erforderliche Rolle: editor oder höher.

Alle Felder sind optional. Geben Sie nur die Felder an, die Sie ändern möchten.

Feld

Typ

Beschreibung

title

string

Formulartitel

description

string

Formularbeschreibung

fields

array

Aktualisierte Felddefinitionen

trigger

object

Aktualisierte Auslöser-Konfiguration

styling

object

Aktualisierte Styling-Optionen

isActive

boolean

Formular aktivieren oder deaktivieren

Ein Lead-Capture-Formular löschen

` DELETE /leads/forms/:formId `

Erforderliche Rolle: editor oder höher.

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

Antwort

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

Aktive Formulare abrufen (Öffentlich)

Rufen Sie nur die aktiven Lead-Capture-Formulare für eine Publikation ab. Dies ist ein öffentlicher Endpunkt, der vom Viewer verwendet wird, um zu wissen, welche Formulare angezeigt werden sollen.

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

Keine Authentifizierung erforderlich. Gibt nur Formulare zurück, bei denen isActive auf true gesetzt ist.

← Previous
Analytics-API
Next →
Publications-API