Waitlist API
Manage your waitlist subscribers programmatically.
List Subscribers
GET
/api/v1/waitlist/subscribers
Query Parameters
| Parameter | Type | Description |
|---|---|---|
page |
integer | Page number (default: 1) |
per_page |
integer | Items per page (default: 20, max: 100) |
search |
string | Search by email or name |
Response
{
"success": true,
"data": [
{
"id": 1,
"email": "[email protected]",
"name": "John Doe",
"position": 42,
"referral_code": "abc123",
"referral_count": 5,
"created_at": "2024-01-15T10:30:00Z"
}
],
"meta": {
"page": 1,
"per_page": 20,
"total": 150
}
}Add Subscriber
POST
/api/v1/waitlist/subscribers
Request Body
| Parameter | Type | Description |
|---|---|---|
email |
string (required) | messages.docs_param_email |
name |
string | messages.docs_param_name |
referral_code |
string | messages.docs_param_referral_code |
tags |
array | messages.docs_param_tags |
Example Request
curl -X POST "https://yourproject.premonize.com/api/v1/waitlist/subscribers" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"email": "[email protected]",
"name": "Jane Smith",
"referral_code": "abc123",
"tags": ["vip", "early-adopter"]
}'Response
{
"success": true,
"data": {
"id": 151,
"email": "[email protected]",
"name": "Jane Smith",
"position": 151,
"referral_code": "xyz789",
"share_url": "https://yourproject.premonize.com/waitlist?ref=xyz789"
}
}Get Subscriber
GET
/api/v1/waitlist/subscribers/{id}
Delete Subscriber
DELETE
/api/v1/waitlist/subscribers/{id}
Get Statistics
GET
/api/v1/waitlist/stats
Response
{
"success": true,
"data": {
"total_subscribers": 1250,
"today_signups": 45,
"referral_rate": 23.5,
"top_referrers": [
{"email": "[email protected]", "referrals": 28}
]
}
}Was this page helpful?
Your feedback helps us improve our documentation
Thank you for your feedback!
Your input helps us create better documentation for everyone