API & Webhooks Documentation
Flier's API manages contacts, campaigns, templates, and email sending through Gmail. Protected endpoints require an authenticated session; mutations also require a CSRF token. Configure webhooks in your account settings to receive campaign event notifications.
API reference overview
The reference below lists the documented endpoints. Expand the interactive reference for request parameters and responses, or download the OpenAPI specification.
| Method | Endpoint | Purpose |
|---|---|---|
| GET | /api/appwrite/contacts | List all contacts |
| POST | /api/appwrite/contacts | Create a new contact |
| DELETE | /api/appwrite/contacts | Delete a contact |
| GET | /api/appwrite/campaigns | List all campaigns |
| POST | /api/appwrite/campaigns | Create a new campaign |
| GET | /api/appwrite/templates | List all templates |
| POST | /api/appwrite/templates | Create a new template |
| PUT | /api/appwrite/templates | Update a template |
| DELETE | /api/appwrite/templates | Delete a template |
| POST | /api/send-email | Send email campaign |
| GET | /api/activity/campaign-stats | Get campaign statistics |
| POST | /api/send-single-email | Send single email |
| POST | /api/upload-attachment | Upload email attachments |
| GET | /api/gdpr/export | Export user data |
| DELETE | /api/gdpr/delete | Delete all user data |
| GET | /api/teams | List all teams |
| POST | /api/teams | Create a new team |
Interactive API reference
New to Flier? Learn how to send a Gmail mail merge or explore the campaign features.