API reference
v1.4.0- Base URL
https://api.app2email.com/v1/YOUR_NUMBER/- Auth
Authorization: Bearer YOUR_API_KEY· also accepted:X-API-KEY· keys: dashboard- Number
- Spec
- openapi.json Postman docs-api.md llms.txt
Quick start
-
curl "https://api.app2email.com/v1/YOUR_NUMBER/me" \ -H "Authorization: Bearer YOUR_API_KEY" -
curl "https://api.app2email.com/v1/YOUR_NUMBER/templates" \ -H "Authorization: Bearer YOUR_API_KEY" -
curl -X POST "https://api.app2email.com/v1/YOUR_NUMBER/messages" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "to": "61412345678", "type": "template", "template": { "name": "order_update", "language": { "code": "en" }, "components": [ { "type": "body", "parameters": [ { "type": "text", "text": "John" }, { "type": "text", "text": "#1234" } ] } ] }, "dry_run": true }'
Automation tools and agents
Every tool uses the same API key and the same calls as this reference.
- AI agents
- Claude, Cursor, VS Code, Codex and OpenClaw connect to the MCP server: that page has the install lines for each. An agent that has to create the account first uses the Management MCP.
- n8n
- The HTTP Request node, with openapi.json imported. Start a workflow from a Webhook node that receives the webhook events.
- Zapier
- "Webhooks by Zapier": a POST step for the calls, a Catch Hook trigger for the webhook events.
- Make
- Import openapi.json as a custom app, or use the HTTP module. A "Custom webhook" receives the webhook events.
- Power Automate, Logic Apps
- A custom connector from the Swagger 2.0 file swagger2.json. The API key goes in the Authorization header as
Bearer YOUR_API_KEY. - A2A (Agent-to-Agent)
- Your agent answers WhatsApp: on the dashboard's Integrations page, give the URL of your A2A agent. Incoming messages become A2A tasks and the answer goes back to the contact.
app2email as an agent: the agent card is at api.app2email.com/.well-known/agent-card.json. - Agent Skills
- A skill package that teaches an agent this API: /.well-known/skills/index.json. Install it with
npx skills add https://www.app2email.com.
Groups
Send WhatsApp messages (templates and free-form replies), read them and look up their status.
Upload files for sends; download the files contacts sent.
One thread per contact: the 24 hour window, its messages and its owner (handoff).
Your WhatsApp templates: list, create, look up, delete.
WhatsApp Flows: forms and screens inside WhatsApp. Shared by every number of the WhatsApp Business Account.
Appointment bookings made on WhatsApp Flows: the appointments, the free slots, the booking settings, and sending the number's Flows.
Event tickets: events with one or many dates, ticket types and extras, what is left, orders and refunds, the tickets with their check-in state, promo codes, the waiting list and door lists. Create a key with the permission Event tickets on the API keys page. Your systems can list events and what is left, find an order, issue complimentary tickets or record a sale paid at your till, refund, send tickets again, and check tickets in from your own scanner. Eight webhook events report an order confirmed or refunded, a ticket checked in or passed on, a date sold out or cancelled, a waiting-list entry and an erased buyer. AI assistants can do the same through the hosted MCP server. Sandbox keys can read but cannot issue, refund or check in.
Forms a business defines as a plain list of questions. app2email turns each one into a WhatsApp form and a web page; what people send becomes a submission that moves through stages in a shared inbox and sets off automations: replies, e-mails, calculations and calls to outside systems. Start with GET /submit/guide, build everything with one POST /submit/setup, then publish the form.
A product catalog with its own order page: customers order from WhatsApp or the web for pickup or delivery, pay online or at the counter, and collect with a QR code. Orders are managed in the dashboard and the counter app; these events tell your system what happens to an order.
Lists of numbers (API or Broadcast page): status, the result per number, scheduling and cancelling.
Contacts with tags, custom fields and consent records, and segments (saved filters) to send to.
Records that people agreed to your messages, and the rule that requires them for marketing.
Numbers marketing templates are not sent to.
Sends held by a key's approval gate, waiting for a person.
The number at WhatsApp: health, business profile, display name, username, QR codes, conversation starters, commerce.
Auto reply, email forwarding, and the number's settings (email behaviour, caps, compliance).
Events sent to your URL: https://www.app2email.com/docs/api/webhooks
WhatsApp's own figures: cost and volume, sent and delivered, the account's activity log, conversion events.
WhatsApp voice calls through your own WebRTC or SIP stack: settings, call actions, call permissions.
The key, plan, usage, statistics and the request log.
All numbers of an account: agent sign-up, status, number keys, plans, payment links, usage, account keys. Account key (a2ea_...) or the management_key of create_account.
Resellers: the partner account, clients, their numbers and number keys, onboarding links, usage, payments, partner webhooks. Partner key (a2ep_...) from /reseller/api-keys.
The business calendar: appointments, blocked time, internal notes, links to the online booking page and held times. Services, staff and the next free times for agents.
Payments for appointments through the business's own Stripe or PayPal account, one-off payment requests, refunds, prepaid packages, the customer profile (with GDPR-style erase) and meeting polls.