Access Links API
Create and manage access links for your lead magnets.
Overview
Access links allow recipients to view your lead magnets. Each link can have optional restrictions like email requirements, view limits, and expiration dates.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/access-links | List all access links |
POST | /api/v1/access-links | Create an access link |
GET | /api/v1/access-links/:id | Get a specific access link |
PATCH | /api/v1/access-links/:id | Update an access link |
DELETE | /api/v1/access-links/:id | Delete an access link |
List Access Links
Retrieve access links, optionally filtered by lead magnet.
GET/api/v1/access-links
Query Parameters
| Parameter | Type | Description |
|---|---|---|
lead_magnet_id | string | Filter by lead magnet (UUID) |
page | integer | Page number (default: 1) |
per_page | integer | Items per page (default: 20, max: 100) |
is_active | string | Filter by status: true, false, or all (default: all) |
Response
json
Create Access Link
Create a new access link for a lead magnet. Requires write scope.
POST/api/v1/access-links
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
lead_magnet_id | string | Yes | ID of the lead magnet (UUID) |
email | string | No | Recipient email |
max_views | integer | No | Maximum view count (1-10000) |
expires_at | string | No | Expiration date (ISO 8601 datetime) |
is_active | boolean | No | Active status (default: true) |
Example
cURL CommandN8N Ready
Response
json
Get Access Link
Retrieve a specific access link by ID.
GET/api/v1/access-links/{id}
Response
json
Update Access Link
Update an existing access link. Requires write scope.
PATCH/api/v1/access-links/{id}
Request Body
All fields are optional:
| Field | Type | Description |
|---|---|---|
email | string | Recipient email |
max_views | integer | Maximum view count |
expires_at | string | Expiration date (ISO 8601) |
is_active | boolean | Active status |
Example
cURL CommandN8N Ready
Bulk Create Access Links
Create multiple access links at once.
POST/api/v1/lead-magnets/{id}/bulk-links
Request Body
| Field | Type | Description |
|---|---|---|
emails | array | Array of email addresses |
max_views | integer | Max views for all links |
expires_at | string | Expiration for all links |
Example
cURL CommandN8N Ready
Response
json
Use bulk link creation for event registration lists or campaign distribution.
Delete Access Link
Delete an access link. The link will immediately stop working. Requires write scope.
DELETE/api/v1/access-links/{id}
Example
cURL CommandN8N Ready
Response
json
Access Link Object
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier (UUID) |
lead_magnet_id | string | Associated lead magnet ID |
email | string | Recipient email address |
code | string | Unique access code |
views | number | Current view count |
max_views | number | Maximum allowed views |
is_active | boolean | Whether link is active |
expires_at | string | Expiration timestamp |
created_at | string | Creation timestamp |