Lead Capture API
Build and manage lead capture forms, collect viewer submissions from your publications, and export lead data as CSV.
- Capture a Lead (Public)
- Path Parameters
- Request Body
- Example Request
- Example Response
- List Leads
- Query Parameters
- Example Request
- Example Response
- Export Leads as CSV
- Query Parameters
- Example Request
- Example Response
- Lead Capture Forms
- List Forms for a Publication
- Example Request
- Example Response
- Create a Lead Capture Form
- Update a Lead Capture Form
- Delete a Lead Capture Form
- Response
- Get Active Forms (Public)
Lead Capture API
The Lead Capture API lets you create forms that appear within your flipbook publications to collect viewer information. You can configure form fields, trigger conditions, and styling. Captured leads are stored and available for listing, searching, and CSV export.
Base URL: https://api.zenflip.io/v1/leads
Capture a Lead (Public)
Submit a lead from the publication viewer. This is a public endpoint --- no authentication is required. It is called by the embedded viewer when a reader fills out a lead capture form.
Rate limit: 10 submissions per minute per IP address.
Path Parameters
Parameter | Type | Description |
| string | Publication UUID |
Request Body
Field | Type | Required | Description |
| string | Yes | Email address of the lead |
| string | No | Full name |
| string | No | Company or organization name |
| string | No | Phone number |
| object | No | Key-value pairs for custom form fields |
| integer | No | Page number where the form was triggered |
| string | No | How the form appeared: |
Example Request
Example Response
List Leads
Retrieve a paginated list of all captured leads for your organization.
Query Parameters
Parameter | Type | Required | Description |
| string | No | Filter by publication ID |
| integer | No | Page number (default: 1) |
| integer | No | Items per page (default: 20) |
| string | No | Search by email or name |
Example Request
Example Response
Export Leads as CSV
Export all leads for your organization (or a specific publication) as a CSV file.
Query Parameters
Parameter | Type | Required | Description |
| string | No | Filter by publication ID |
Example Request
Example Response
Lead Capture Forms
Lead capture forms define the fields, trigger conditions, and styling for forms shown to viewers inside your publications.
List Forms for a Publication
Example Request
Example Response
Create a Lead Capture Form
Required role: editor or above. Required plan feature: leadCapture.
Request Body
Field | Type | Required | Description |
| string | Yes | Form title (max 200 characters) |
| string | No | Description shown above the form |
| array | Yes | Array of field definitions (see below) |
| object | Yes | Trigger configuration (see below) |
| object | No | Custom styling options |
Field Definition Object
Property | Type | Description |
| string | Field identifier (used as the key in submissions) |
| string | Field type: |
| string | Display label for the field |
| boolean | Whether the field is required |
| array | Options for |
Trigger Configuration Object
Property | Type | Description |
| string | Trigger type: |
| integer | Page number (for |
| integer | Seconds to wait (for |
| integer | Scroll percentage (for |
Example Request
Update a Lead Capture Form
Required role: editor or above.
All fields are optional. Only include the fields you want to change.
Field | Type | Description |
| string | Form title |
| string | Form description |
| array | Updated field definitions |
| object | Updated trigger configuration |
| object | Updated styling options |
| boolean | Enable or disable the form |
Delete a Lead Capture Form
Required role: editor or above.
Response
Get Active Forms (Public)
Retrieve only the active lead capture forms for a publication. This is a public endpoint used by the viewer to know which forms to display.
No authentication required. Returns only forms where isActive is true.