Lead Magnets API
Create, retrieve, update, and delete PDF lead magnets via the API.
Overview
The Lead Magnets API allows you to manage your PDF lead magnets programmatically.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/lead-magnets | List all lead magnets |
POST | /api/v1/lead-magnets | Create a lead magnet |
GET | /api/v1/lead-magnets/:id | Get a specific lead magnet |
PATCH | /api/v1/lead-magnets/:id | Update a lead magnet |
DELETE | /api/v1/lead-magnets/:id | Delete a lead magnet |
POST | /api/v1/lead-magnets/:id/bulk-links | Create bulk access links |
List Lead Magnets
Retrieve all lead magnets for your account.
GET/api/v1/lead-magnets
Query Parameters
| Parameter | Type | Description |
|---|---|---|
page | integer | Page number (default: 1) |
per_page | integer | Items per page (default: 20, max: 100) |
is_active | string | Filter by active status: true, false, or all (default: all) |
Response
json
Example
cURL CommandN8N Ready
Create Lead Magnet
Create a new PDF lead magnet. Requires write scope.
POST/api/v1/lead-magnets
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Lead magnet title (max 255 chars) |
description | string | No | Description |
file_path | string | No | Path to uploaded PDF file |
is_active | boolean | No | Active status (default: true) |
Example
cURL CommandN8N Ready
Response
json
Get Lead Magnet
Retrieve a specific lead magnet by ID.
GET/api/v1/lead-magnets/{id}
Response
json
Update Lead Magnet
Update an existing lead magnet. Requires write scope.
PATCH/api/v1/lead-magnets/{id}
Request Body
All fields are optional:
| Field | Type | Description |
|---|---|---|
title | string | Lead magnet title |
description | string | Description |
file_path | string | Path to uploaded PDF file |
is_active | boolean | Active status |
Example
cURL CommandN8N Ready
Delete Lead Magnet
Delete a lead magnet and all associated access links. Requires write scope.
DELETE/api/v1/lead-magnets/{id}
This action is permanent. All access links for this lead magnet will stop working.
Example
cURL CommandN8N Ready
Response
json
Lead Magnet Object
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier (UUID) |
title | string | Lead magnet title |
description | string | Description |
type | string | Always pdf |
file_path | string | Path to uploaded PDF file |
is_active | boolean | Whether lead magnet is active |
created_at | string | Creation timestamp |
updated_at | string | Last update timestamp |