Campaign management
Create campaigns, monitor status, and review delivery metrics for live volume operations.
Developer Reference
Integrate campaign creation, reporting, and webhook-based automation with a crawlable HTML reference plus an interactive schema explorer.
Create campaigns, monitor status, and review delivery metrics for live volume operations.
Trigger internal workflows when campaigns start, finish, or require operator review.
Collect normalized JSON responses so dashboards and BI tools can track campaign performance.
Send a bearer token with every request. Responses are JSON and use standard HTTP status codes for success, validation errors, and authorization failures.
Webhook events are signed and designed for delivery retries so operational tooling can safely process campaign updates.
| Method | Path | Purpose |
|---|---|---|
| GET | /api/boosts | List campaigns with current status, chain, and recent activity. |
| POST | /api/boosts | Create a new campaign for a token and submit budget parameters. |
| GET | /api/boosts/{id} | Fetch campaign details, delivery history, and health indicators. |
| POST | /api/webhooks/test | Send a verification event to confirm webhook configuration. |
Use the explorer below to inspect schemas and example payloads. The static summary above remains available to crawlers and readers without JavaScript.