The HoopAI Platform Emails REST API gives you full programmatic access to email marketing operations. Create and manage drag-and-drop or HTML templates, retrieve scheduled email campaigns and workflow campaigns, fetch bulk-action campaign lists, and pull delivery statistics — all through a single, consistent interface.Documentation Index
Fetch the complete documentation index at: https://help.hoopai.com/llms.txt
Use this file to discover all available pages before exploring further.
Base URL
Authentication
Every request requires a Bearer token and an API version header.OAuth scopes
| Scope | Access granted |
|---|---|
emails/schedule.readonly | Read scheduled campaigns and campaign statistics |
emails/builder.readonly | Read email templates |
emails/builder.write | Create, update, and delete email templates |
Quick start
Fetch all email templates for a location:Endpoints
| Method | Path | Description |
|---|---|---|
GET | /emails/schedule | Get campaigns |
POST | /emails/builder | Create a new template |
GET | /emails/builder | Fetch email templates |
POST | /emails/builder/data | Update a template |
DELETE | /emails/builder/{locationId}/{templateId} | Delete a template |
PATCH | /emails/builder/{templateId} | Update a template with settings |
GET | /emails/stats/location/{locationId}/{source}/{sourceId} | Get campaign statistics |
GET | /emails/campaigns/workflows | Get workflow campaigns |
GET | /emails/campaigns/bulk-actions | Get bulk action campaigns |