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

  1. curl "https://api.app2email.com/v1/YOUR_NUMBER/me" \
      -H "Authorization: Bearer YOUR_API_KEY"
  2. curl "https://api.app2email.com/v1/YOUR_NUMBER/templates" \
      -H "Authorization: Bearer YOUR_API_KEY"
  3. 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

Messages 5

Send WhatsApp messages (templates and free-form replies), read them and look up their status.

Media 3

Upload files for sends; download the files contacts sent.

Conversations 4

One thread per contact: the 24 hour window, its messages and its owner (handoff).

Templates 14

Your WhatsApp templates: list, create, look up, delete.

Flows 13

WhatsApp Flows: forms and screens inside WhatsApp. Shared by every number of the WhatsApp Business Account.

Book-and-Pay 13

Appointment bookings made on WhatsApp Flows: the appointments, the free slots, the booking settings, and sending the number's Flows.

Tickets-and-Pay 33

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.

Submit-Info 42

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.

Order-and-Pay 19

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.

Broadcasts 4

Lists of numbers (API or Broadcast page): status, the result per number, scheduling and cancelling.

Contacts 19

Contacts with tags, custom fields and consent records, and segments (saved filters) to send to.

Opt-ins 5

Records that people agreed to your messages, and the rule that requires them for marketing.

Do Not Call 4

Numbers marketing templates are not sent to.

Approvals 3

Sends held by a key's approval gate, waiting for a person.

Number 25

The number at WhatsApp: health, business profile, display name, username, QR codes, conversation starters, commerce.

Settings 6

Auto reply, email forwarding, and the number's settings (email behaviour, caps, compliance).

Webhooks 16

Events sent to your URL: https://www.app2email.com/docs/api/webhooks

Analytics 7

WhatsApp's own figures: cost and volume, sent and delivered, the account's activity log, conversion events.

Calling 4

WhatsApp voice calls through your own WebRTC or SIP stack: settings, call actions, call permissions.

Account 7

The key, plan, usage, statistics and the request log.

Account management 24

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.

Partner 25

Resellers: the partner account, clients, their numbers and number keys, onboarding links, usage, payments, partner webhooks. Partner key (a2ep_...) from /reseller/api-keys.

Calendar 20

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 17

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.

All calls

Method Path Summary Scope
Messages
GET /v1/{number}/messages Messages sent and received, newest first messages:read
POST /v1/{number}/messages Send a WhatsApp message: template, or free-form reply messages:send
GET /v1/{number}/messages/{message_id} Status of a sent message messages:read
POST /v1/{number}/messages/read Mark a received message as read, optionally typing messages:send
GET /v1/{number}/marketing Where marketing templates go: Cloud API or Marketing Messages API messages:read
Media
POST /v1/{number}/media Upload a file once, get a media id messages:send
GET /v1/{number}/media/{id} Download a received file (stored copy, else from WhatsApp) messages:read
DELETE /v1/{number}/media/{id} Delete an uploaded file at WhatsApp messages:send
Conversations
GET /v1/{number}/conversations The contacts, most recent activity first messages:read
GET /v1/{number}/conversations/{phone}/messages One contact's messages, both directions messages:read
GET /v1/{number}/conversations/{contact} One contact: window state, last messages, owner messages:read
PUT /v1/{number}/conversations/{contact}/owner Hand a contact over: human, agent, paused, or back to normal messages:send
Templates
GET /v1/{number}/templates List your templates, with an example request for each messages:read
POST /v1/{number}/templates Create a template and submit it for approval templates:manage
GET /v1/{number}/templates/{name} One template: status, rejection reason, what it needs messages:read
PATCH /v1/{number}/templates/{name} Edit a template (components, category, TTL, max price) templates:manage
DELETE /v1/{number}/templates/{name} Delete a template (every language, or one) templates:manage
POST /v1/{number}/templates/delete Delete several templates at once (all or nothing) templates:manage
POST /v1/{number}/templates/{name}/archive Archive a template (deleted by WhatsApp after 28 days) templates:manage
POST /v1/{number}/templates/{name}/unarchive Unarchive a template templates:manage
GET /v1/{number}/templates/{name}/compare Compare two templates: block rate, sends, top block reason messages:read
PUT /v1/{number}/templates/{name}/authentication Create or update an authentication template in many languages templates:manage
GET /v1/{number}/template-previews Authentication template texts, per language messages:read
GET /v1/{number}/template-library Meta's Template Library (pre-approved templates) messages:read
GET /v1/{number}/template-insights Template insights: sent, delivered, read, clicked, cost messages:read
POST /v1/{number}/template-insights Switch template insights on (cannot be undone) templates:manage
Flows
GET /v1/{number}/flows List WhatsApp Flows messages:read|bookings:manage
POST /v1/{number}/flows Create a flow (draft, or published at once) templates:manage
GET /v1/{number}/flows/{id} One flow: status, validation errors, health messages:read
PATCH /v1/{number}/flows/{id} Change a flow's name, categories or endpoint templates:manage
DELETE /v1/{number}/flows/{id} Delete a draft flow templates:manage
GET /v1/{number}/flows/{id}/json A flow's Flow JSON messages:read
PUT /v1/{number}/flows/{id}/json Replace a flow's Flow JSON templates:manage
POST /v1/{number}/flows/{id}/publish Publish a flow (cannot be undone) templates:manage
POST /v1/{number}/flows/{id}/deprecate Deprecate a published flow (cannot be undone) templates:manage
GET /v1/{number}/flows/{id}/preview A public preview link of a flow (30 days) messages:read
POST /v1/{number}/flows/{id}/preview A new preview link of a flow (the old one stops working) templates:manage
GET /v1/{number}/flows/encryption-key The number's public key for flows with a data endpoint messages:read
PUT /v1/{number}/flows/encryption-key Set the number's public key for flow endpoints templates:manage
Book-and-Pay
GET /v1/{number}/bookings/waitlist The waitlist of full days bookings:manage|messages:read
POST /v1/{number}/bookings/waitlist Put a customer on the waitlist of a full day bookings:manage
POST /v1/{number}/bookings/waitlist/{reference}/remove Take a customer off the waitlist bookings:manage
GET /v1/{number}/bookings The appointments, soonest start first bookings:manage|messages:read
POST /v1/{number}/bookings Book an appointment for a customer at a free slot bookings:manage
GET /v1/{number}/bookings/availability The free slots per day for a service, as the customer would see them bookings:manage|messages:read
GET /v1/{number}/bookings/reports The booking report of a range of days bookings:manage|messages:read
GET /v1/{number}/bookings/{id} One appointment, by id or reference bookings:manage|messages:read
POST /v1/{number}/bookings/{id}/cancel Cancel an appointment bookings:manage
POST /v1/{number}/bookings/{id}/status Mark an appointment completed, a no-show, or back to confirmed bookings:manage
GET /v1/{number}/settings/booking The booking settings, the default Flow's status and every Flow bookings:manage|messages:read
PUT /v1/{number}/settings/booking Switch Book-and-Pay on or off and change the settings bookings:manage
POST /v1/{number}/flows/{key}/send Send a Flow to a contact (the booking form or another form) bookings:manage
Tickets-and-Pay
GET /v1/{number}/tickets/events The events, newest first tickets:manage
POST /v1/{number}/tickets/events Create an event as a draft with one date and one ticket type tickets:manage
GET /v1/{number}/tickets/events/{id} One event with its dates and ticket types tickets:manage
PATCH /v1/{number}/tickets/events/{id} Change an event tickets:manage
POST /v1/{number}/tickets/events/{id}/publish Publish an event so tickets can be bought tickets:manage
POST /v1/{number}/tickets/events/{id}/cancel Cancel an event and refund or void its tickets tickets:manage
GET /v1/{number}/tickets/events/{id}/dates The dates of an event with what is sold and left tickets:manage
POST /v1/{number}/tickets/events/{id}/dates Add a date to an event tickets:manage
PATCH /v1/{number}/tickets/dates/{date_id} Change a date: time, label, capacity, sales on or paused tickets:manage
POST /v1/{number}/tickets/dates/{date_id}/cancel Cancel one date and refund or void its tickets tickets:manage
GET /v1/{number}/tickets/dates/{date_id}/door The door list of a date for your own scanner tickets:manage
GET /v1/{number}/tickets/events/{id}/types The ticket types and extras of an event tickets:manage
POST /v1/{number}/tickets/events/{id}/types Add a ticket type or an extra to an event tickets:manage
PATCH /v1/{number}/tickets/types/{type_id} Change or archive a ticket type tickets:manage
GET /v1/{number}/tickets/events/{id}/availability What is on sale and how many are left for a date tickets:manage
GET /v1/{number}/tickets/orders The ticket orders, newest first tickets:manage
POST /v1/{number}/tickets/orders Issue complimentary tickets or record a sale paid outside tickets:manage
GET /v1/{number}/tickets/orders/{id} One order with its tickets, by id or reference tickets:manage
POST /v1/{number}/tickets/orders/{id}/refund Refund an order or some of its tickets tickets:manage
POST /v1/{number}/tickets/orders/{id}/resend Send the buyer their tickets again tickets:manage
GET /v1/{number}/tickets/issued The tickets (attendees) with their check-in state tickets:manage
GET /v1/{number}/tickets/issued/{id} One ticket tickets:manage
POST /v1/{number}/tickets/issued/{id}/void Void one ticket without a refund tickets:manage
POST /v1/{number}/tickets/check-ins Check a ticket in (or out) by its code or id tickets:manage
POST /v1/{number}/tickets/check-ins/{scan_id}/undo Take a check-in back tickets:manage
GET /v1/{number}/tickets/codes The promo and access codes with their uses tickets:manage
POST /v1/{number}/tickets/codes Create a promo or access code tickets:manage
PATCH /v1/{number}/tickets/codes/{id} Change a promo code or switch it off tickets:manage
DELETE /v1/{number}/tickets/codes/{id} Delete a promo code no order has used tickets:manage
GET /v1/{number}/tickets/waitlist The waiting list of a sold-out date tickets:manage
GET /v1/{number}/tickets/stats Sales and check-in figures of an event or one date tickets:manage
GET /v1/{number}/settings/tickets The ticket settings and whether ticket sales are switched on tickets:manage
PUT /v1/{number}/settings/tickets Switch ticket sales on or off and change the settings tickets:manage
Submit-Info
GET /v1/{number}/submit/guide The Submit-Info guide for agents: every key, rule and example submissions:manage
GET /v1/{number}/submit/settings Submit-Info settings: the switch, the config and the public code submissions:manage
PUT /v1/{number}/submit/settings Switch Submit-Info on or off and change its settings submissions:manage
POST /v1/{number}/submit/setup Apply or dry-run a whole setup: forms, lists, automations submissions:manage
GET /v1/{number}/submit/presets The ready-made setups (presets), or one complete preset submissions:manage
GET /v1/{number}/submit/forms The forms of the number submissions:manage
POST /v1/{number}/submit/forms Create a form from a definition or a preset submissions:manage
GET /v1/{number}/submit/forms/{key} One form: definition, fields, links and WhatsApp state submissions:manage
PUT /v1/{number}/submit/forms/{key} Change a form: name, on or off, archive, definition submissions:manage
DELETE /v1/{number}/submit/forms/{key} Delete a form (archived when it has submissions) submissions:manage
POST /v1/{number}/submit/forms/{key}/publish Publish a form to WhatsApp submissions:manage
POST /v1/{number}/submit/forms/{key}/send Send a form to a contact, with values filled in submissions:manage
GET /v1/{number}/submit/lists The choice lists (sites, jobs, price lists) submissions:manage
PUT /v1/{number}/submit/lists/{key} Create a list or replace its items submissions:manage
DELETE /v1/{number}/submit/lists/{key} Delete a list submissions:manage
GET /v1/{number}/submit/submissions The submissions, filtered and paged (JSON or CSV) submissions:manage
POST /v1/{number}/submit/submissions Create a submission from data you already hold submissions:manage
GET /v1/{number}/submit/submissions/{id} One submission with files, activity and what can be done submissions:manage
PATCH /v1/{number}/submit/submissions/{id} Change a submission: stage, assignee, tags, answers submissions:manage
DELETE /v1/{number}/submit/submissions/{id} Delete a submission, or erase it for good submissions:manage
POST /v1/{number}/submit/submissions/{id}/notes Write an internal note on a submission submissions:manage
POST /v1/{number}/submit/submissions/{id}/reply Message the submitter, with up to 3 buttons submissions:manage
POST /v1/{number}/submit/submissions/{id}/files Attach a file to a submission submissions:manage
POST /v1/{number}/submit/submissions/{id}/run Run a manual automation on a submission submissions:manage
GET /v1/{number}/submit/members The team: who works in the shared inbox submissions:manage
POST /v1/{number}/submit/members Invite a person to the shared inbox by e-mail submissions:manage
PUT /v1/{number}/submit/members/{id} Change a member's role, abilities or forms submissions:manage
DELETE /v1/{number}/submit/members/{id} Remove a member from the inbox submissions:manage
GET /v1/{number}/submit/automations The automations submissions:manage
POST /v1/{number}/submit/automations Create an automation: when, if, do submissions:manage
POST /v1/{number}/submit/automations/try Try an automation on a real submission, saving and sending nothing submissions:manage
GET /v1/{number}/submit/automations/{id} One automation submissions:manage
PUT /v1/{number}/submit/automations/{id} Change an automation, or switch it on or off submissions:manage
DELETE /v1/{number}/submit/automations/{id} Delete an automation submissions:manage
GET /v1/{number}/submit/runs The automation run log, step by step submissions:manage
GET /v1/{number}/submit/connections The connections to outside systems submissions:manage
PUT /v1/{number}/submit/connections/{key} Create or change a connection (HTTP, OpenAPI or MCP) submissions:manage
DELETE /v1/{number}/submit/connections/{key} Delete a connection submissions:manage
POST /v1/{number}/submit/connections/{key}/test Test a connection: can app2email reach it and sign in? submissions:manage
POST /v1/{number}/submit/connections/{key}/refresh Read a connection's operations or tools again submissions:manage
GET /v1/{number}/submit/connections/{key}/functions What an action can call on a connection submissions:manage
GET /v1/{number}/submit/report Submission counts by form, stage, day and assignee submissions:manage
Order-and-Pay
GET /v1/{number}/shop The shop: on or off, open now, the order page, counts and limits orders:manage
GET /v1/{number}/shop/settings Every setting of the shop, as the shop uses it orders:manage
PUT /v1/{number}/shop/settings Change settings of the shop orders:manage
GET /v1/{number}/shop/categories The categories of the catalog orders:manage
GET /v1/{number}/shop/items Search and filter the products orders:manage
POST /v1/{number}/shop/items Add a product orders:manage
GET /v1/{number}/shop/items/{id} One product with variants, option groups and pictures orders:manage
PUT /v1/{number}/shop/items/{id} Change a product: only the keys sent change orders:manage
DELETE /v1/{number}/shop/items/{id} Archive a product orders:manage
POST /v1/{number}/shop/items/{id}/stock Set or change the stock of a product orders:manage
POST /v1/{number}/shop/items/{id}/sold_out Mark a product sold out for a while, or back orders:manage
GET /v1/{number}/shop/orders The orders, newest first orders:manage
POST /v1/{number}/shop/orders Place an order for a customer orders:manage
GET /v1/{number}/shop/orders/{id} One order with lines, payment, next steps and history orders:manage
POST /v1/{number}/shop/orders/{id}/action Move an order on, change its time, cancel or decline it orders:manage
POST /v1/{number}/shop/orders/{id}/refund Refund an order that was paid online orders:manage
POST /v1/{number}/shop/quote Price a cart: total, problems, times and ways to pay orders:manage
GET /v1/{number}/shop/report The shop's figures for a range of days orders:manage
POST /v1/{number}/shop/link A customer's personal link to the order page orders:manage
Broadcasts
GET /v1/{number}/broadcasts Your latest broadcasts messages:read
GET /v1/{number}/broadcasts/{code} A broadcast's status and the result per number messages:read
GET /v1/{number}/broadcasts/{code}/results.csv A broadcast's result for each message, as CSV messages:read
POST /v1/{number}/broadcasts/{code}/cancel Cancel a scheduled or sending API broadcast messages:send
Contacts
GET /v1/{number}/contacts Your contacts, newest first messages:read
POST /v1/{number}/contacts Make or update contacts (one, or a list of up to 1000) contacts:manage
POST /v1/{number}/contacts/import Import contacts from CSV or JSON (up to 5000 rows) contacts:manage
GET /v1/{number}/contacts/export.csv All contacts as CSV messages:read
GET /v1/{number}/contacts/{identity} One contact messages:read
PATCH /v1/{number}/contacts/{identity} Change a contact contacts:manage
DELETE /v1/{number}/contacts/{identity} Delete a contact record contacts:manage
POST /v1/{number}/contacts/{identity}/consent Record consent (or its withdrawal) with evidence contacts:manage
GET /v1/{number}/segments Your segments (saved contact filters) messages:read
POST /v1/{number}/segments Save a contact filter as a segment contacts:manage
GET /v1/{number}/segments/{id} One segment, with how many contacts match now messages:read
PUT /v1/{number}/segments/{id} Rename a segment or replace its filter contacts:manage
DELETE /v1/{number}/segments/{id} Delete a segment (its contacts stay) contacts:manage
GET /v1/{number}/segments/{id}/contacts The contacts a segment matches now messages:read
GET /v1/{number}/blocked WhatsApp users this number blocked messages:read
POST /v1/{number}/blocked Block WhatsApp users contacts:manage
DELETE /v1/{number}/blocked Unblock WhatsApp users contacts:manage
GET /v1/{number}/contact-book/{bsuid} Is a phone number on file for a business-scoped user id messages:read
DELETE /v1/{number}/contact-book/{bsuid} Remove a business-scoped user id from the contact book contacts:manage
Opt-ins
GET /v1/{number}/settings/optin Is the opt-in rule for marketing on? settings:manage
PUT /v1/{number}/settings/optin Turn the opt-in rule for marketing on or off settings:manage
GET /v1/{number}/optins The opt-in records, or check one number settings:manage
POST /v1/{number}/optins Record that people opted in settings:manage
DELETE /v1/{number}/optins/{phone} Remove an opt-in record settings:manage
Do Not Call
GET /v1/{number}/donotcall The Do Not Call list, or check one number dnc:manage
POST /v1/{number}/donotcall Add numbers to the Do Not Call list dnc:manage
DELETE /v1/{number}/donotcall/{phone} Remove a number from the Do Not Call list dnc:manage
GET /v1/{number}/compliance/export.csv Consent records, Do Not Call list and opt-ins as one CSV dnc:manage
Approvals
GET /v1/{number}/approvals Sends held for approval messages:read
POST /v1/{number}/approvals/{id}/approve Approve a held send: it is sent now messages:send
POST /v1/{number}/approvals/{id}/reject Reject a held send: nothing is sent messages:send
Number
GET /v1/{number}/health Number health: can it send, quality, limit, name status messages:read
PUT /v1/{number}/settings/identity-check Turn WhatsApp's identity change check on or off settings:manage
GET /v1/{number}/profile The WhatsApp business profile messages:read
PATCH /v1/{number}/profile Change the WhatsApp business profile settings:manage
PUT /v1/{number}/profile/photo Change the profile photo from a public link settings:manage
PUT /v1/{number}/profile/display-name Submit a new display name for Meta's review settings:manage
GET /v1/{number}/profile/official-business-account Official Business Account (blue tick) status messages:read
POST /v1/{number}/profile/official-business-account Request an Official Business Account (blue tick) settings:manage
GET /v1/{number}/profile/india-compliance India business compliance information messages:read
PUT /v1/{number}/profile/india-compliance Set the India business compliance information settings:manage
GET /v1/{number}/username The business username messages:read
PUT /v1/{number}/username Adopt or change the business username settings:manage
DELETE /v1/{number}/username Remove the business username settings:manage
GET /v1/{number}/username/suggestions Usernames reserved for the business messages:read
GET /v1/{number}/settings/conversation-starters Ice breakers, commands and welcome message messages:read
PUT /v1/{number}/settings/conversation-starters Set ice breakers, commands or the welcome message settings:manage
GET /v1/{number}/qr-codes QR codes and short links messages:read
POST /v1/{number}/qr-codes Create a QR code and wa.me short link settings:manage
GET /v1/{number}/qr-codes/{code} One QR code messages:read
PATCH /v1/{number}/qr-codes/{code} Change a QR code's prefilled message settings:manage
DELETE /v1/{number}/qr-codes/{code} Delete a QR code and its short link settings:manage
GET /v1/{number}/settings/commerce Cart and catalog icon on or off messages:read
PUT /v1/{number}/settings/commerce Turn the cart or the catalog icon on or off settings:manage
GET /v1/{number}/catalog The connected product catalog messages:read
PUT /v1/{number}/catalog Connect a product catalog settings:manage
Settings
GET /v1/{number}/settings/autoreply The auto reply to new contacts settings:manage
PUT /v1/{number}/settings/autoreply Change the auto reply text settings:manage
GET /v1/{number}/settings/forwarding Who gets the messages by email settings:manage
PUT /v1/{number}/settings/forwarding Change who gets the messages by email settings:manage
GET /v1/{number}/settings/number The number's settings: email behaviour, caps, compliance messages:read
PUT /v1/{number}/settings/number Change some of the number's settings settings:manage
Webhooks
GET /v1/{number}/webhooks Your webhooks webhooks:manage
POST /v1/{number}/webhooks Get events at your URL webhooks:manage
GET /v1/{number}/webhooks/samples A sample of every event webhooks:manage
PATCH /v1/{number}/webhooks/{id} Change a webhook: url, active, headers, format webhooks:manage
DELETE /v1/{number}/webhooks/{id} Delete a webhook webhooks:manage
POST /v1/{number}/webhooks/{id}/test Send a test event now webhooks:manage
POST /v1/{number}/webhooks/{id}/rotate-secret Make a new signing secret webhooks:manage
GET /v1/{number}/webhooks/{id}/deliveries The last deliveries, with every attempt webhooks:manage
GET /v1/{number}/webhooks/{id}/deliveries/{event_id} One delivery, with the event as it was sent webhooks:manage
POST /v1/{number}/webhooks/{id}/deliveries/{event_id}/redeliver Send a stored event again webhooks:manage
GET /v1/{number}/events Fetch events (no webhook address needed) messages:read
POST /v1/{number}/webhooks/test-url Send a test event to any URL webhooks:manage
GET /v1/{number}/webhooks/catchers Your catchers webhooks:manage
POST /v1/{number}/webhooks/catchers Get a temporary URL that keeps what it receives webhooks:manage
GET /v1/{number}/webhooks/catchers/{token} What a catcher received webhooks:manage
DELETE /v1/{number}/webhooks/catchers/{token} Delete a catcher webhooks:manage
Analytics
GET /v1/{number}/analytics/pricing WhatsApp cost and volume of this number messages:read
GET /v1/{number}/analytics/messages Messages sent and delivered, as WhatsApp counts them messages:read
GET /v1/{number}/activity The WhatsApp Business Account's activity log messages:read
GET /v1/{number}/conversions/dataset The Conversions API dataset of the account messages:read
POST /v1/{number}/conversions/dataset Create the Conversions API dataset settings:manage
GET /v1/{number}/conversions/dataset/quality Quality of the Conversions API dataset messages:read
POST /v1/{number}/conversions/events Send conversion events of WhatsApp chats messages:send
Calling
GET /v1/{number}/calling/settings WhatsApp calling settings calls:manage
PATCH /v1/{number}/calling/settings Change the calling settings calls:manage
POST /v1/{number}/calls Start, answer, reject or end a WhatsApp call calls:manage
GET /v1/{number}/calls/permissions/{contact} May the number call this contact calls:manage
Account
GET /v1/{number}/me Check the key: its scopes, the number, the plan and the limits any key
GET /v1/{number}/requests The latest logged API requests messages:read
GET /v1/{number}/requests/{id} One logged request, by its request_id messages:read
GET /v1/{number}/usage/history Messages and broadcasts per month messages:read
GET /v1/{number}/stats Message counts, delivery and read rates for a period messages:read
GET /v1/{number}/usage Plan, messages used and left, limits, what WhatsApp charges messages:read
GET /v1/{number}/usage/meta What WhatsApp charges this billing month, per day messages:read
Account management
POST /v1/account/sandbox Instant sandbox: try the API with no account any key
POST /v1/account/signup Start an account for a person (agent sign-up) any key
GET /v1/account Account status and what is still needed any key
GET /v1/account/plans Plans that can be bought any key
GET /v1/account/estimate Cost estimate for a number of messages a month any key
GET /v1/account/numbers The account's WhatsApp numbers account:read
GET /v1/account/numbers/{number} One number of the account account:read
GET /v1/account/numbers/{number}/keys The keys of a number keys:manage
POST /v1/account/numbers/{number}/keys Create a key for a number keys:manage
DELETE /v1/account/numbers/{number}/keys/{key_id} Revoke a key of a number keys:manage
POST /v1/account/numbers/{number}/checkout Payment link for a plan of a number account:manage
GET /v1/account/usage Messages used this billing month, per number billing:read
GET /v1/account/keys Account keys account:manage
POST /v1/account/keys Create an account key account:manage
DELETE /v1/account/keys/{key_id} Revoke an account key account:manage
GET /v1/account/webhooks Account webhooks webhooks:manage
POST /v1/account/webhooks Add an account webhook webhooks:manage
PATCH /v1/account/webhooks/{id} Change an account webhook webhooks:manage
DELETE /v1/account/webhooks/{id} Delete an account webhook webhooks:manage
POST /v1/account/webhooks/{id}/test Send a test event to an account webhook webhooks:manage
POST /v1/account/webhooks/{id}/rotate-secret New signing secret for an account webhook webhooks:manage
GET /v1/account/webhooks/{id}/deliveries Deliveries of an account webhook webhooks:manage
GET /v1/account/webhooks/{id}/deliveries/{event_id} One delivery of an account webhook webhooks:manage
POST /v1/account/webhooks/{id}/deliveries/{event_id}/redeliver Send a stored event again to an account webhook webhooks:manage
Partner
GET /v1/partner The partner account partner:read
PATCH /v1/partner Change the partner settings partner:manage
GET /v1/partner/clients Clients partner:read
POST /v1/partner/clients Create a client clients:manage
GET /v1/partner/clients/{client_id} One client partner:read
PATCH /v1/partner/clients/{client_id} Change a client clients:manage
GET /v1/partner/clients/{client_id}/usage Usage of a client billing:read
GET /v1/partner/numbers Numbers of your clients partner:read
GET /v1/partner/numbers/{number} One number partner:read
GET /v1/partner/numbers/{number}/usage Usage of a number billing:read
GET /v1/partner/numbers/{number}/keys Keys of a number keys:manage
POST /v1/partner/numbers/{number}/keys Create a key for a client's number keys:manage
DELETE /v1/partner/numbers/{number}/keys/{key_id} Revoke a key of a client's number keys:manage
POST /v1/partner/onboarding-links Onboarding link for a new or existing client clients:manage
GET /v1/partner/payments Client payments billing:read
GET /v1/partner/subscriptions Client plans billing:read
GET /v1/partner/webhooks Partner webhooks webhooks:manage
POST /v1/partner/webhooks Add a partner webhook webhooks:manage
PATCH /v1/partner/webhooks/{id} Change a partner webhook webhooks:manage
DELETE /v1/partner/webhooks/{id} Delete a partner webhook webhooks:manage
POST /v1/partner/webhooks/{id}/test Send a test event to a partner webhook webhooks:manage
POST /v1/partner/webhooks/{id}/rotate-secret New signing secret for a partner webhook webhooks:manage
GET /v1/partner/webhooks/{id}/deliveries Deliveries of a partner webhook webhooks:manage
GET /v1/partner/webhooks/{id}/deliveries/{event_id} One delivery of a partner webhook webhooks:manage
POST /v1/partner/webhooks/{id}/deliveries/{event_id}/redeliver Send a stored event again to a partner webhook webhooks:manage
Calendar
PATCH /v1/{number}/bookings/{id} Change an appointment's details bookings:manage
GET /v1/{number}/calendar Everything on the calendar for a range of days bookings:manage|messages:read
GET /v1/{number}/calendar/blocks The blocked times bookings:manage|messages:read
POST /v1/{number}/calendar/blocks Block time so that no one can book it bookings:manage
PATCH /v1/{number}/calendar/blocks/{id} Change a blocked time bookings:manage
DELETE /v1/{number}/calendar/blocks/{id} Remove a blocked time bookings:manage
GET /v1/{number}/bookings/services The services a customer can book, and their staff bookings:manage|messages:read
GET /v1/{number}/bookings/staff The staff members and the services they do bookings:manage|messages:read
GET /v1/{number}/bookings/next The next free start times for a service, across days bookings:manage|messages:read
POST /v1/{number}/bookings/{id}/reschedule Move an appointment to another time bookings:manage
GET /v1/{number}/bookings/{id}/notes The internal notes of an appointment and its customer bookings:manage|messages:read
POST /v1/{number}/bookings/{id}/notes Add an internal note to an appointment bookings:manage
GET /v1/{number}/bookings/notes The internal notes of a customer bookings:manage|messages:read
POST /v1/{number}/bookings/notes Add an internal note to a customer bookings:manage
DELETE /v1/{number}/bookings/notes/{note_id} Delete an internal note bookings:manage
GET /v1/{number}/bookings/links The personal booking links bookings:manage|messages:read
POST /v1/{number}/bookings/links Make a link that opens the online booking page bookings:manage
DELETE /v1/{number}/bookings/links/{code} Revoke a personal booking link bookings:manage
POST /v1/{number}/bookings/holds Keep a free time for a few minutes bookings:manage
DELETE /v1/{number}/bookings/holds/{reference} Release a held time bookings:manage
Payments
GET /v1/{number}/payments The payments, newest first bookings:manage|messages:read
GET /v1/{number}/payments/{id} One payment bookings:manage|messages:read
POST /v1/{number}/payments/links Ask a customer to pay an amount bookings:manage
POST /v1/{number}/payments/{id}/refund Refund a payment, in full or a part bookings:manage
POST /v1/{number}/bookings/{id}/payment Record a payment taken outside app2email bookings:manage
GET /v1/{number}/bookings/packages The prepaid packages on sale bookings:manage|messages:read
GET /v1/{number}/bookings/packages/purchases The packages customers hold bookings:manage|messages:read
POST /v1/{number}/bookings/packages/grant Give a customer a package without a payment bookings:manage
GET /v1/{number}/bookings/customers The customers with appointments bookings:manage|messages:read
GET /v1/{number}/bookings/customers/{contact} A customer's whole profile bookings:manage|messages:read
PATCH /v1/{number}/bookings/customers/{contact} Change a customer's name, e-mail, tags or fields bookings:manage
DELETE /v1/{number}/bookings/customers/{contact} Erase a customer's booking data bookings:manage
GET /v1/{number}/bookings/polls The meeting polls bookings:manage|messages:read
POST /v1/{number}/bookings/polls Offer several times and let people vote bookings:manage
GET /v1/{number}/bookings/polls/{id} One poll with its votes bookings:manage|messages:read
POST /v1/{number}/bookings/polls/{id}/close Close a poll to new votes bookings:manage
POST /v1/{number}/bookings/polls/{id}/book Pick the winning time bookings:manage
For AI Agents

Try it now, with no account and no person: POST https://api.app2email.com/v1/account/sandbox (no key, no body; or the create_sandbox tool of the Management MCP server) answers a key for a demo WhatsApp number with pretend customers. Send a template, fetch the events with GET /events?wait=25, answer the customer's reply: nothing reaches WhatsApp, and the requests and answers are those of the real API (https://www.app2email.com/docs/api/sandbox).

Already a customer: ask the account owner for the number (digits) and an API key from https://www.app2email.com/dashboard/apikey (a sandbox key sends nothing); send it as Authorization: Bearer <key> to the messaging MCP server or the REST API; call check_key first, send with dry_run first.

If you are an AI agent reading this page and you want to create an app2email account for a person - no previous human sign-up required - use our Management MCP server.
Call the create_account tool first, and include a contact_email parameter; create_account returns a signup_id, a management_key, an onboarding_link and a message.
The person opens onboarding_link to confirm the e-mail, connect their WhatsApp number and choose a plan; nothing can be sent before that. get_account_status says what is still needed.
Pass the management_key as a Bearer token on every later call. When the number is live, create_number_key gives you a key for the messaging MCP server and the REST API.