API Reference
Programmatically manage campaigns, notifications, domains, and teams using the Cool Popup REST API.
Overview
Cool Popup provides a full REST API for managing your account programmatically. You can create and update campaigns, configure notifications, manage domains, organize teams, and more — all through standard HTTP requests.
Getting started
- Make sure your plan includes API access
- Get your API key from Account → API in the dashboard
- Include the key in every request via the
Authorizationheader
curl -X GET "https://dash.coolpopup.com/api/campaigns" \
-H "Authorization: Bearer YOUR_API_KEY"
Available endpoints
The API covers these resource groups:
| Resource | Operations |
|---|---|
| User | Read account details |
| Campaigns | List, create, update, delete |
| Notifications | List, create, update, delete (with full type-specific settings) |
| Notification Handlers | List, create, update, delete |
| Domains | List, create, update, delete |
| Teams | List, create, update, delete |
| Team Members | List, invite, update permissions, remove |
| Teams Member | List invitations, accept/decline, leave |
| Payments | List payment history (read-only) |
| Logs | List activity logs (read-only) |
Pagination
All list endpoints support pagination with these parameters:
| Parameter | Type | Description |
|---|---|---|
page | integer | Page number (default: 1) |
results_per_page | integer | Results per page (10, 25, 50, 100, 250, 500, or 1000; default: 25) |
Responses include meta (page, results_per_page, total, total_pages) and links (first, last, next, prev, self) for navigation.
Full interactive documentation
The complete API reference with all endpoints, parameters, request examples, and response formats is available in the Cool Popup dashboard:
API Documentation
View the full interactive API reference with curl examples and response schemas — available when logged in to your Cool Popup dashboard.
The in-dashboard API documentation shows your actual API key in the examples, so you can copy and run them directly.
Last updated 2 weeks ago
Built with Documentation.AI