API Documentation

Overview
Authentication
Feature Gates
Endpoint Groups
Examples

API Overview

The public API lets you integrate email campaigns, subscribers, quota checks, transactional email, WhatsApp, Facebook, workspaces, attachments, templates and analytics.

Base URL: https://app.infomail.ai/api/v1

Authentication

Supported API integrations use Bearer tokens generated from the API Tokens page.

Authorization: Bearer YOUR_API_TOKEN

Important: This documentation intentionally documents token-based API access only.

curl -X GET "https://app.infomail.ai/api/v1/subscribers" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Feature Gates

Most data endpoints require the plan feature api_access.
WhatsApp endpoints also require whatsapp.
Facebook endpoints also require facebook_ads.
Plan listing and usage endpoints remain available outside the api_access gate.

Endpoint Groups

Campaigns

Method	Endpoint	Description
GET	`/api/v1/campaigns`	List campaigns
POST	`/api/v1/campaigns`	Create campaign
GET	`/api/v1/campaigns/{id}`	Show campaign
PUT/PATCH	`/api/v1/campaigns/{id}`	Update campaign
DELETE	`/api/v1/campaigns/{id}`	Delete campaign
POST	`/api/v1/campaigns/{id}/send`	Send campaign
GET	`/api/v1/campaigns/{id}/stats`	Campaign statistics
GET	`/api/v1/campaigns/{id}/messages`	Campaign messages
GET	`/api/v1/campaigns/{id}/export`	Campaign CSV export
GET	`/api/v1/stats/campaigns`	All campaign statistics

Subscribers and Quota

Method	Endpoint	Description
GET	`/api/v1/subscribers`	List subscribers with bounce and abuse fields
POST	`/api/v1/subscribers`	Create or update subscriber by email
GET	`/api/v1/subscribers/{id}`	Show subscriber
GET	`/api/v1/quota`	Current quota status
POST	`/api/v1/quota/check`	Check if a volume can be sent

Transactional and Spam Check

Method	Endpoint	Description
POST	`/api/v1/transactional/send`	Send transactional email
GET	`/api/v1/transactional/{messageId}`	Transactional email status
GET	`/api/v1/transactional/templates/{id}`	Transactional template details
POST	`/api/v1/spam-check/analyze`	Full spam analysis
POST	`/api/v1/spam-check/quick`	Quick spam check
GET	`/api/v1/spam-check/status`	Spam check service status

Workspace, Optional Fields, Templates and Attachments

Group	Endpoints
Workspaces	`/api/v1/workspaces`, `/api/v1/workspaces/{id}/users`
Optional Fields	`/api/v1/optional-fields`
Template import/export	`/api/v1/templates/import`, `/api/v1/templates/{id}/export`, `/api/v1/templates/{id}/content`
Attachments	`/api/v1/attachments`, `/api/v1/attachments/download/{storedName}`

WhatsApp API

Requires both api_access and whatsapp plan features.

Method	Endpoint	Description
GET	`/api/v1/whatsapp/templates`	List templates
POST	`/api/v1/whatsapp/templates`	Create template
GET	`/api/v1/whatsapp/campaigns`	List campaigns
POST	`/api/v1/whatsapp/campaigns`	Create campaign
POST	`/api/v1/whatsapp/campaigns/{id}/schedule`	Schedule campaign
POST	`/api/v1/whatsapp/campaigns/{id}/send`	Send campaign
POST	`/api/v1/whatsapp/campaigns/{id}/cancel`	Cancel campaign
GET	`/api/v1/whatsapp/campaigns/{id}/preview-recipients`	Preview recipients
GET	`/api/v1/whatsapp/analytics`	Overall analytics
GET	`/api/v1/whatsapp/analytics/export`	Analytics export
GET	`/api/v1/whatsapp/analytics/campaigns/{id}`	Campaign analytics
POST	`/api/v1/whatsapp/analytics/campaigns/{id}/recalculate`	Recalculate analytics
POST	`/api/v1/transactional/whatsapp/send`	Send transactional WhatsApp
GET	`/api/v1/transactional/whatsapp/{messageId}`	Transactional WhatsApp status

Facebook API

Requires both api_access and facebook_ads plan features.

Method	Endpoint	Description
GET	`/api/v1/facebook/audiences`	List audiences
POST	`/api/v1/facebook/audiences`	Create audience
POST	`/api/v1/facebook/audiences/{id}/sync`	Sync subscribers to audience
GET	`/api/v1/facebook/audiences/{id}/stats`	Audience stats
DELETE	`/api/v1/facebook/audiences/{id}`	Delete audience
POST	`/api/v1/facebook/campaigns/{campaignId}/sync-audience`	Sync a campaign audience
GET	`/api/v1/facebook/campaigns/{campaignId}/audiences`	Campaign-linked audiences
POST	`/api/v1/facebook/campaigns/{campaignId}/track-conversion`	Track campaign conversion
POST	`/api/v1/facebook/events`	Send a conversion event
POST	`/api/v1/facebook/events/batch`	Send a batch of conversion events

Examples

Transactional Email

curl -X POST "https://app.infomail.ai/api/v1/transactional/send" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "cliente@example.com",
    "subject": "Conferma ordine #12345",
    "content": "<html><body>Ordine confermato</body></html>",
    "from_email": "ordini@acme.com",
    "from_name": "Acme"
  }'

Transactional WhatsApp

curl -X POST "https://app.infomail.ai/api/v1/transactional/whatsapp/send" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+393331234567",
    "template_id": 12,
    "parameters": {
      "body": ["Mario", "ORD-12345"]
    },
    "reference": "order-12345",
    "idempotency_key": "order-12345-whatsapp"
  }'

Facebook Events

curl -X POST "https://app.infomail.ai/api/v1/facebook/events" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "event_name": "Purchase",
    "user_data": {
      "email": "mario@example.com"
    },
    "custom_data": {
      "value": 79.90,
      "currency": "EUR"
    }
  }'

Contents