# app2email WhatsApp API

HTML: https://www.app2email.com/docs/api · Index: https://www.app2email.com/docs/api/llms.txt

Version 1.4.0 · 332 calls · OpenAPI: https://www.app2email.com/docs/api/openapi.json

## Basics

|  |  |
| --- | --- |
| Base URL | `https://api.app2email.com/v1/{number}/` |
| {number} | the WhatsApp number you send from, digits only, country code first |
| Auth | `Authorization: Bearer YOUR_API_KEY` (also accepted: `X-API-KEY`). Keys: https://www.app2email.com/dashboard/apikey |
| Sandbox key | does every check, sends nothing: https://www.app2email.com/docs/api/sandbox.md |
| Errors | `{"success": false, "request_id", "error": {"code", "message", "how_to_fix", ...}}`: https://www.app2email.com/docs/api/errors.md |
| Limits | https://www.app2email.com/docs/api/limits.md |
| MCP | `https://api.app2email.com/mcp` (same Bearer key) |

## Quick start

1. Check the key: [GET /v1/{number}/me](https://www.app2email.com/docs/api/account/get-me.md)

```bash
curl "https://api.app2email.com/v1/YOUR_NUMBER/me" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

2. List your templates: [GET /v1/{number}/templates](https://www.app2email.com/docs/api/templates/list-templates.md)

```bash
curl "https://api.app2email.com/v1/YOUR_NUMBER/templates" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

3. Send a template (dry run): [POST /v1/{number}/messages](https://www.app2email.com/docs/api/messages/send-template-message.md)

```bash
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
}'
```

## All calls

### Messages

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

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/{number}/messages` | [Messages sent and received, newest first](https://www.app2email.com/docs/api/messages/list-messages.md) | `messages:read` |
| POST | `/v1/{number}/messages` | [Send a WhatsApp message: template, or free-form reply](https://www.app2email.com/docs/api/messages/send-template-message.md) | `messages:send` |
| GET | `/v1/{number}/messages/{message_id}` | [Status of a sent message](https://www.app2email.com/docs/api/messages/get-message-status.md) | `messages:read` |
| POST | `/v1/{number}/messages/read` | [Mark a received message as read, optionally typing](https://www.app2email.com/docs/api/messages/mark-message-read.md) | `messages:send` |
| GET | `/v1/{number}/marketing` | [Where marketing templates go: Cloud API or Marketing Messages API](https://www.app2email.com/docs/api/messages/get-marketing-status.md) | `messages:read` |

### Media

Upload files for sends; download the files contacts sent.

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| POST | `/v1/{number}/media` | [Upload a file once, get a media id](https://www.app2email.com/docs/api/media/upload-media.md) | `messages:send` |
| GET | `/v1/{number}/media/{id}` | [Download a received file (stored copy, else from WhatsApp)](https://www.app2email.com/docs/api/media/get-media.md) | `messages:read` |
| DELETE | `/v1/{number}/media/{id}` | [Delete an uploaded file at WhatsApp](https://www.app2email.com/docs/api/media/delete-media.md) | `messages:send` |

### Conversations

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

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/{number}/conversations` | [The contacts, most recent activity first](https://www.app2email.com/docs/api/conversations/list-conversations.md) | `messages:read` |
| GET | `/v1/{number}/conversations/{phone}/messages` | [One contact's messages, both directions](https://www.app2email.com/docs/api/conversations/list-conversation-messages.md) | `messages:read` |
| GET | `/v1/{number}/conversations/{contact}` | [One contact: window state, last messages, owner](https://www.app2email.com/docs/api/conversations/get-conversation.md) | `messages:read` |
| PUT | `/v1/{number}/conversations/{contact}/owner` | [Hand a contact over: human, agent, paused, or back to normal](https://www.app2email.com/docs/api/conversations/set-conversation-owner.md) | `messages:send` |

### Templates

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

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/{number}/templates` | [List your templates, with an example request for each](https://www.app2email.com/docs/api/templates/list-templates.md) | `messages:read` |
| POST | `/v1/{number}/templates` | [Create a template and submit it for approval](https://www.app2email.com/docs/api/templates/create-template.md) | `templates:manage` |
| GET | `/v1/{number}/templates/{name}` | [One template: status, rejection reason, what it needs](https://www.app2email.com/docs/api/templates/get-template.md) | `messages:read` |
| PATCH | `/v1/{number}/templates/{name}` | [Edit a template (components, category, TTL, max price)](https://www.app2email.com/docs/api/templates/edit-template.md) | `templates:manage` |
| DELETE | `/v1/{number}/templates/{name}` | [Delete a template (every language, or one)](https://www.app2email.com/docs/api/templates/delete-template.md) | `templates:manage` |
| POST | `/v1/{number}/templates/delete` | [Delete several templates at once (all or nothing)](https://www.app2email.com/docs/api/templates/delete-templates.md) | `templates:manage` |
| POST | `/v1/{number}/templates/{name}/archive` | [Archive a template (deleted by WhatsApp after 28 days)](https://www.app2email.com/docs/api/templates/archive-template.md) | `templates:manage` |
| POST | `/v1/{number}/templates/{name}/unarchive` | [Unarchive a template](https://www.app2email.com/docs/api/templates/unarchive-template.md) | `templates:manage` |
| GET | `/v1/{number}/templates/{name}/compare` | [Compare two templates: block rate, sends, top block reason](https://www.app2email.com/docs/api/templates/compare-templates.md) | `messages:read` |
| PUT | `/v1/{number}/templates/{name}/authentication` | [Create or update an authentication template in many languages](https://www.app2email.com/docs/api/templates/upsert-auth-template.md) | `templates:manage` |
| GET | `/v1/{number}/template-previews` | [Authentication template texts, per language](https://www.app2email.com/docs/api/templates/preview-auth-templates.md) | `messages:read` |
| GET | `/v1/{number}/template-library` | [Meta's Template Library (pre-approved templates)](https://www.app2email.com/docs/api/templates/list-template-library.md) | `messages:read` |
| GET | `/v1/{number}/template-insights` | [Template insights: sent, delivered, read, clicked, cost](https://www.app2email.com/docs/api/templates/get-template-insights.md) | `messages:read` |
| POST | `/v1/{number}/template-insights` | [Switch template insights on (cannot be undone)](https://www.app2email.com/docs/api/templates/enable-template-insights.md) | `templates:manage` |

### Flows

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

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/{number}/flows` | [List WhatsApp Flows](https://www.app2email.com/docs/api/flows/list-flows.md) | `messages:read\|bookings:manage` |
| POST | `/v1/{number}/flows` | [Create a flow (draft, or published at once)](https://www.app2email.com/docs/api/flows/create-flow.md) | `templates:manage` |
| GET | `/v1/{number}/flows/{id}` | [One flow: status, validation errors, health](https://www.app2email.com/docs/api/flows/get-flow.md) | `messages:read` |
| PATCH | `/v1/{number}/flows/{id}` | [Change a flow's name, categories or endpoint](https://www.app2email.com/docs/api/flows/update-flow.md) | `templates:manage` |
| DELETE | `/v1/{number}/flows/{id}` | [Delete a draft flow](https://www.app2email.com/docs/api/flows/delete-flow.md) | `templates:manage` |
| GET | `/v1/{number}/flows/{id}/json` | [A flow's Flow JSON](https://www.app2email.com/docs/api/flows/get-flow-json.md) | `messages:read` |
| PUT | `/v1/{number}/flows/{id}/json` | [Replace a flow's Flow JSON](https://www.app2email.com/docs/api/flows/update-flow-json.md) | `templates:manage` |
| POST | `/v1/{number}/flows/{id}/publish` | [Publish a flow (cannot be undone)](https://www.app2email.com/docs/api/flows/publish-flow.md) | `templates:manage` |
| POST | `/v1/{number}/flows/{id}/deprecate` | [Deprecate a published flow (cannot be undone)](https://www.app2email.com/docs/api/flows/deprecate-flow.md) | `templates:manage` |
| GET | `/v1/{number}/flows/{id}/preview` | [A public preview link of a flow (30 days)](https://www.app2email.com/docs/api/flows/get-flow-preview.md) | `messages:read` |
| POST | `/v1/{number}/flows/{id}/preview` | [A new preview link of a flow (the old one stops working)](https://www.app2email.com/docs/api/flows/renew-flow-preview.md) | `templates:manage` |
| GET | `/v1/{number}/flows/encryption-key` | [The number's public key for flows with a data endpoint](https://www.app2email.com/docs/api/flows/get-flow-encryption-key.md) | `messages:read` |
| PUT | `/v1/{number}/flows/encryption-key` | [Set the number's public key for flow endpoints](https://www.app2email.com/docs/api/flows/set-flow-encryption-key.md) | `templates:manage` |

### Book-and-Pay

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

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/{number}/bookings/waitlist` | [The waitlist of full days](https://www.app2email.com/docs/api/book-and-pay/list-booking-waitlist.md) | `bookings:manage\|messages:read` |
| POST | `/v1/{number}/bookings/waitlist` | [Put a customer on the waitlist of a full day](https://www.app2email.com/docs/api/book-and-pay/add-to-booking-waitlist.md) | `bookings:manage` |
| POST | `/v1/{number}/bookings/waitlist/{reference}/remove` | [Take a customer off the waitlist](https://www.app2email.com/docs/api/book-and-pay/remove-from-booking-waitlist.md) | `bookings:manage` |
| GET | `/v1/{number}/bookings` | [The appointments, soonest start first](https://www.app2email.com/docs/api/book-and-pay/list-bookings.md) | `bookings:manage\|messages:read` |
| POST | `/v1/{number}/bookings` | [Book an appointment for a customer at a free slot](https://www.app2email.com/docs/api/book-and-pay/create-booking.md) | `bookings:manage` |
| GET | `/v1/{number}/bookings/availability` | [The free slots per day for a service, as the customer would see them](https://www.app2email.com/docs/api/book-and-pay/get-booking-availability.md) | `bookings:manage\|messages:read` |
| GET | `/v1/{number}/bookings/reports` | [The booking report of a range of days](https://www.app2email.com/docs/api/book-and-pay/get-booking-reports.md) | `bookings:manage\|messages:read` |
| GET | `/v1/{number}/bookings/{id}` | [One appointment, by id or reference](https://www.app2email.com/docs/api/book-and-pay/get-booking.md) | `bookings:manage\|messages:read` |
| POST | `/v1/{number}/bookings/{id}/cancel` | [Cancel an appointment](https://www.app2email.com/docs/api/book-and-pay/cancel-booking.md) | `bookings:manage` |
| POST | `/v1/{number}/bookings/{id}/status` | [Mark an appointment completed, a no-show, or back to confirmed](https://www.app2email.com/docs/api/book-and-pay/set-booking-status.md) | `bookings:manage` |
| GET | `/v1/{number}/settings/booking` | [The booking settings, the default Flow's status and every Flow](https://www.app2email.com/docs/api/book-and-pay/get-booking-settings.md) | `bookings:manage\|messages:read` |
| PUT | `/v1/{number}/settings/booking` | [Switch Book-and-Pay on or off and change the settings](https://www.app2email.com/docs/api/book-and-pay/update-booking-settings.md) | `bookings:manage` |
| POST | `/v1/{number}/flows/{key}/send` | [Send a Flow to a contact (the booking form or another form)](https://www.app2email.com/docs/api/book-and-pay/send-flow.md) | `bookings:manage` |

### Tickets-and-Pay

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.

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/{number}/tickets/events` | [The events, newest first](https://www.app2email.com/docs/api/tickets-and-pay/list-ticket-events.md) | `tickets:manage` |
| POST | `/v1/{number}/tickets/events` | [Create an event as a draft with one date and one ticket type](https://www.app2email.com/docs/api/tickets-and-pay/create-ticket-event.md) | `tickets:manage` |
| GET | `/v1/{number}/tickets/events/{id}` | [One event with its dates and ticket types](https://www.app2email.com/docs/api/tickets-and-pay/get-ticket-event.md) | `tickets:manage` |
| PATCH | `/v1/{number}/tickets/events/{id}` | [Change an event](https://www.app2email.com/docs/api/tickets-and-pay/update-ticket-event.md) | `tickets:manage` |
| POST | `/v1/{number}/tickets/events/{id}/publish` | [Publish an event so tickets can be bought](https://www.app2email.com/docs/api/tickets-and-pay/publish-ticket-event.md) | `tickets:manage` |
| POST | `/v1/{number}/tickets/events/{id}/cancel` | [Cancel an event and refund or void its tickets](https://www.app2email.com/docs/api/tickets-and-pay/cancel-ticket-event.md) | `tickets:manage` |
| GET | `/v1/{number}/tickets/events/{id}/dates` | [The dates of an event with what is sold and left](https://www.app2email.com/docs/api/tickets-and-pay/list-ticket-dates.md) | `tickets:manage` |
| POST | `/v1/{number}/tickets/events/{id}/dates` | [Add a date to an event](https://www.app2email.com/docs/api/tickets-and-pay/create-ticket-date.md) | `tickets:manage` |
| PATCH | `/v1/{number}/tickets/dates/{date_id}` | [Change a date: time, label, capacity, sales on or paused](https://www.app2email.com/docs/api/tickets-and-pay/update-ticket-date.md) | `tickets:manage` |
| POST | `/v1/{number}/tickets/dates/{date_id}/cancel` | [Cancel one date and refund or void its tickets](https://www.app2email.com/docs/api/tickets-and-pay/cancel-ticket-date.md) | `tickets:manage` |
| GET | `/v1/{number}/tickets/dates/{date_id}/door` | [The door list of a date for your own scanner](https://www.app2email.com/docs/api/tickets-and-pay/get-ticket-door-list.md) | `tickets:manage` |
| GET | `/v1/{number}/tickets/events/{id}/types` | [The ticket types and extras of an event](https://www.app2email.com/docs/api/tickets-and-pay/list-ticket-types.md) | `tickets:manage` |
| POST | `/v1/{number}/tickets/events/{id}/types` | [Add a ticket type or an extra to an event](https://www.app2email.com/docs/api/tickets-and-pay/create-ticket-type.md) | `tickets:manage` |
| PATCH | `/v1/{number}/tickets/types/{type_id}` | [Change or archive a ticket type](https://www.app2email.com/docs/api/tickets-and-pay/update-ticket-type.md) | `tickets:manage` |
| GET | `/v1/{number}/tickets/events/{id}/availability` | [What is on sale and how many are left for a date](https://www.app2email.com/docs/api/tickets-and-pay/get-ticket-availability.md) | `tickets:manage` |
| GET | `/v1/{number}/tickets/orders` | [The ticket orders, newest first](https://www.app2email.com/docs/api/tickets-and-pay/list-ticket-orders.md) | `tickets:manage` |
| POST | `/v1/{number}/tickets/orders` | [Issue complimentary tickets or record a sale paid outside](https://www.app2email.com/docs/api/tickets-and-pay/create-ticket-order.md) | `tickets:manage` |
| GET | `/v1/{number}/tickets/orders/{id}` | [One order with its tickets, by id or reference](https://www.app2email.com/docs/api/tickets-and-pay/get-ticket-order.md) | `tickets:manage` |
| POST | `/v1/{number}/tickets/orders/{id}/refund` | [Refund an order or some of its tickets](https://www.app2email.com/docs/api/tickets-and-pay/refund-ticket-order.md) | `tickets:manage` |
| POST | `/v1/{number}/tickets/orders/{id}/resend` | [Send the buyer their tickets again](https://www.app2email.com/docs/api/tickets-and-pay/resend-ticket-order.md) | `tickets:manage` |
| GET | `/v1/{number}/tickets/issued` | [The tickets (attendees) with their check-in state](https://www.app2email.com/docs/api/tickets-and-pay/list-tickets.md) | `tickets:manage` |
| GET | `/v1/{number}/tickets/issued/{id}` | [One ticket](https://www.app2email.com/docs/api/tickets-and-pay/get-ticket.md) | `tickets:manage` |
| POST | `/v1/{number}/tickets/issued/{id}/void` | [Void one ticket without a refund](https://www.app2email.com/docs/api/tickets-and-pay/void-ticket.md) | `tickets:manage` |
| POST | `/v1/{number}/tickets/check-ins` | [Check a ticket in (or out) by its code or id](https://www.app2email.com/docs/api/tickets-and-pay/check-in-ticket.md) | `tickets:manage` |
| POST | `/v1/{number}/tickets/check-ins/{scan_id}/undo` | [Take a check-in back](https://www.app2email.com/docs/api/tickets-and-pay/undo-ticket-check-in.md) | `tickets:manage` |
| GET | `/v1/{number}/tickets/codes` | [The promo and access codes with their uses](https://www.app2email.com/docs/api/tickets-and-pay/list-ticket-codes.md) | `tickets:manage` |
| POST | `/v1/{number}/tickets/codes` | [Create a promo or access code](https://www.app2email.com/docs/api/tickets-and-pay/create-ticket-code.md) | `tickets:manage` |
| PATCH | `/v1/{number}/tickets/codes/{id}` | [Change a promo code or switch it off](https://www.app2email.com/docs/api/tickets-and-pay/update-ticket-code.md) | `tickets:manage` |
| DELETE | `/v1/{number}/tickets/codes/{id}` | [Delete a promo code no order has used](https://www.app2email.com/docs/api/tickets-and-pay/delete-ticket-code.md) | `tickets:manage` |
| GET | `/v1/{number}/tickets/waitlist` | [The waiting list of a sold-out date](https://www.app2email.com/docs/api/tickets-and-pay/list-ticket-waitlist.md) | `tickets:manage` |
| GET | `/v1/{number}/tickets/stats` | [Sales and check-in figures of an event or one date](https://www.app2email.com/docs/api/tickets-and-pay/get-ticket-stats.md) | `tickets:manage` |
| GET | `/v1/{number}/settings/tickets` | [The ticket settings and whether ticket sales are switched on](https://www.app2email.com/docs/api/tickets-and-pay/get-ticket-settings.md) | `tickets:manage` |
| PUT | `/v1/{number}/settings/tickets` | [Switch ticket sales on or off and change the settings](https://www.app2email.com/docs/api/tickets-and-pay/update-ticket-settings.md) | `tickets:manage` |

### Submit-Info

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.

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/{number}/submit/guide` | [The Submit-Info guide for agents: every key, rule and example](https://www.app2email.com/docs/api/submit-info/get-submit-guide.md) | `submissions:manage` |
| GET | `/v1/{number}/submit/settings` | [Submit-Info settings: the switch, the config and the public code](https://www.app2email.com/docs/api/submit-info/get-submit-settings.md) | `submissions:manage` |
| PUT | `/v1/{number}/submit/settings` | [Switch Submit-Info on or off and change its settings](https://www.app2email.com/docs/api/submit-info/update-submit-settings.md) | `submissions:manage` |
| POST | `/v1/{number}/submit/setup` | [Apply or dry-run a whole setup: forms, lists, automations](https://www.app2email.com/docs/api/submit-info/apply-submit-setup.md) | `submissions:manage` |
| GET | `/v1/{number}/submit/presets` | [The ready-made setups (presets), or one complete preset](https://www.app2email.com/docs/api/submit-info/list-submit-presets.md) | `submissions:manage` |
| GET | `/v1/{number}/submit/forms` | [The forms of the number](https://www.app2email.com/docs/api/submit-info/list-forms.md) | `submissions:manage` |
| POST | `/v1/{number}/submit/forms` | [Create a form from a definition or a preset](https://www.app2email.com/docs/api/submit-info/create-form.md) | `submissions:manage` |
| GET | `/v1/{number}/submit/forms/{key}` | [One form: definition, fields, links and WhatsApp state](https://www.app2email.com/docs/api/submit-info/get-form.md) | `submissions:manage` |
| PUT | `/v1/{number}/submit/forms/{key}` | [Change a form: name, on or off, archive, definition](https://www.app2email.com/docs/api/submit-info/update-form.md) | `submissions:manage` |
| DELETE | `/v1/{number}/submit/forms/{key}` | [Delete a form (archived when it has submissions)](https://www.app2email.com/docs/api/submit-info/delete-form.md) | `submissions:manage` |
| POST | `/v1/{number}/submit/forms/{key}/publish` | [Publish a form to WhatsApp](https://www.app2email.com/docs/api/submit-info/publish-form.md) | `submissions:manage` |
| POST | `/v1/{number}/submit/forms/{key}/send` | [Send a form to a contact, with values filled in](https://www.app2email.com/docs/api/submit-info/send-form.md) | `submissions:manage` |
| GET | `/v1/{number}/submit/lists` | [The choice lists (sites, jobs, price lists)](https://www.app2email.com/docs/api/submit-info/list-submit-lists.md) | `submissions:manage` |
| PUT | `/v1/{number}/submit/lists/{key}` | [Create a list or replace its items](https://www.app2email.com/docs/api/submit-info/set-submit-list.md) | `submissions:manage` |
| DELETE | `/v1/{number}/submit/lists/{key}` | [Delete a list](https://www.app2email.com/docs/api/submit-info/delete-submit-list.md) | `submissions:manage` |
| GET | `/v1/{number}/submit/submissions` | [The submissions, filtered and paged (JSON or CSV)](https://www.app2email.com/docs/api/submit-info/list-submissions.md) | `submissions:manage` |
| POST | `/v1/{number}/submit/submissions` | [Create a submission from data you already hold](https://www.app2email.com/docs/api/submit-info/create-submission.md) | `submissions:manage` |
| GET | `/v1/{number}/submit/submissions/{id}` | [One submission with files, activity and what can be done](https://www.app2email.com/docs/api/submit-info/get-submission.md) | `submissions:manage` |
| PATCH | `/v1/{number}/submit/submissions/{id}` | [Change a submission: stage, assignee, tags, answers](https://www.app2email.com/docs/api/submit-info/update-submission.md) | `submissions:manage` |
| DELETE | `/v1/{number}/submit/submissions/{id}` | [Delete a submission, or erase it for good](https://www.app2email.com/docs/api/submit-info/delete-submission.md) | `submissions:manage` |
| POST | `/v1/{number}/submit/submissions/{id}/notes` | [Write an internal note on a submission](https://www.app2email.com/docs/api/submit-info/add-submission-note.md) | `submissions:manage` |
| POST | `/v1/{number}/submit/submissions/{id}/reply` | [Message the submitter, with up to 3 buttons](https://www.app2email.com/docs/api/submit-info/reply-to-submission.md) | `submissions:manage` |
| POST | `/v1/{number}/submit/submissions/{id}/files` | [Attach a file to a submission](https://www.app2email.com/docs/api/submit-info/add-submission-file.md) | `submissions:manage` |
| POST | `/v1/{number}/submit/submissions/{id}/run` | [Run a manual automation on a submission](https://www.app2email.com/docs/api/submit-info/run-submission-action.md) | `submissions:manage` |
| GET | `/v1/{number}/submit/members` | [The team: who works in the shared inbox](https://www.app2email.com/docs/api/submit-info/list-submit-members.md) | `submissions:manage` |
| POST | `/v1/{number}/submit/members` | [Invite a person to the shared inbox by e-mail](https://www.app2email.com/docs/api/submit-info/invite-submit-member.md) | `submissions:manage` |
| PUT | `/v1/{number}/submit/members/{id}` | [Change a member's role, abilities or forms](https://www.app2email.com/docs/api/submit-info/update-submit-member.md) | `submissions:manage` |
| DELETE | `/v1/{number}/submit/members/{id}` | [Remove a member from the inbox](https://www.app2email.com/docs/api/submit-info/remove-submit-member.md) | `submissions:manage` |
| GET | `/v1/{number}/submit/automations` | [The automations](https://www.app2email.com/docs/api/submit-info/list-automations.md) | `submissions:manage` |
| POST | `/v1/{number}/submit/automations` | [Create an automation: when, if, do](https://www.app2email.com/docs/api/submit-info/create-automation.md) | `submissions:manage` |
| POST | `/v1/{number}/submit/automations/try` | [Try an automation on a real submission, saving and sending nothing](https://www.app2email.com/docs/api/submit-info/try-automation.md) | `submissions:manage` |
| GET | `/v1/{number}/submit/automations/{id}` | [One automation](https://www.app2email.com/docs/api/submit-info/get-automation.md) | `submissions:manage` |
| PUT | `/v1/{number}/submit/automations/{id}` | [Change an automation, or switch it on or off](https://www.app2email.com/docs/api/submit-info/update-automation.md) | `submissions:manage` |
| DELETE | `/v1/{number}/submit/automations/{id}` | [Delete an automation](https://www.app2email.com/docs/api/submit-info/delete-automation.md) | `submissions:manage` |
| GET | `/v1/{number}/submit/runs` | [The automation run log, step by step](https://www.app2email.com/docs/api/submit-info/list-automation-runs.md) | `submissions:manage` |
| GET | `/v1/{number}/submit/connections` | [The connections to outside systems](https://www.app2email.com/docs/api/submit-info/list-connections.md) | `submissions:manage` |
| PUT | `/v1/{number}/submit/connections/{key}` | [Create or change a connection (HTTP, OpenAPI or MCP)](https://www.app2email.com/docs/api/submit-info/set-connection.md) | `submissions:manage` |
| DELETE | `/v1/{number}/submit/connections/{key}` | [Delete a connection](https://www.app2email.com/docs/api/submit-info/delete-connection.md) | `submissions:manage` |
| POST | `/v1/{number}/submit/connections/{key}/test` | [Test a connection: can app2email reach it and sign in?](https://www.app2email.com/docs/api/submit-info/test-connection.md) | `submissions:manage` |
| POST | `/v1/{number}/submit/connections/{key}/refresh` | [Read a connection's operations or tools again](https://www.app2email.com/docs/api/submit-info/refresh-connection.md) | `submissions:manage` |
| GET | `/v1/{number}/submit/connections/{key}/functions` | [What an action can call on a connection](https://www.app2email.com/docs/api/submit-info/list-connection-functions.md) | `submissions:manage` |
| GET | `/v1/{number}/submit/report` | [Submission counts by form, stage, day and assignee](https://www.app2email.com/docs/api/submit-info/get-submit-report.md) | `submissions:manage` |

### Order-and-Pay

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.

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/{number}/shop` | [The shop: on or off, open now, the order page, counts and limits](https://www.app2email.com/docs/api/order-and-pay/get-shop.md) | `orders:manage` |
| GET | `/v1/{number}/shop/settings` | [Every setting of the shop, as the shop uses it](https://www.app2email.com/docs/api/order-and-pay/get-shop-settings.md) | `orders:manage` |
| PUT | `/v1/{number}/shop/settings` | [Change settings of the shop](https://www.app2email.com/docs/api/order-and-pay/update-shop-settings.md) | `orders:manage` |
| GET | `/v1/{number}/shop/categories` | [The categories of the catalog](https://www.app2email.com/docs/api/order-and-pay/list-shop-categories.md) | `orders:manage` |
| GET | `/v1/{number}/shop/items` | [Search and filter the products](https://www.app2email.com/docs/api/order-and-pay/list-shop-items.md) | `orders:manage` |
| POST | `/v1/{number}/shop/items` | [Add a product](https://www.app2email.com/docs/api/order-and-pay/create-shop-item.md) | `orders:manage` |
| GET | `/v1/{number}/shop/items/{id}` | [One product with variants, option groups and pictures](https://www.app2email.com/docs/api/order-and-pay/get-shop-item.md) | `orders:manage` |
| PUT | `/v1/{number}/shop/items/{id}` | [Change a product: only the keys sent change](https://www.app2email.com/docs/api/order-and-pay/update-shop-item.md) | `orders:manage` |
| DELETE | `/v1/{number}/shop/items/{id}` | [Archive a product](https://www.app2email.com/docs/api/order-and-pay/archive-shop-item.md) | `orders:manage` |
| POST | `/v1/{number}/shop/items/{id}/stock` | [Set or change the stock of a product](https://www.app2email.com/docs/api/order-and-pay/set-shop-stock.md) | `orders:manage` |
| POST | `/v1/{number}/shop/items/{id}/sold_out` | [Mark a product sold out for a while, or back](https://www.app2email.com/docs/api/order-and-pay/set-shop-sold-out.md) | `orders:manage` |
| GET | `/v1/{number}/shop/orders` | [The orders, newest first](https://www.app2email.com/docs/api/order-and-pay/list-shop-orders.md) | `orders:manage` |
| POST | `/v1/{number}/shop/orders` | [Place an order for a customer](https://www.app2email.com/docs/api/order-and-pay/create-shop-order.md) | `orders:manage` |
| GET | `/v1/{number}/shop/orders/{id}` | [One order with lines, payment, next steps and history](https://www.app2email.com/docs/api/order-and-pay/get-shop-order.md) | `orders:manage` |
| POST | `/v1/{number}/shop/orders/{id}/action` | [Move an order on, change its time, cancel or decline it](https://www.app2email.com/docs/api/order-and-pay/update-shop-order.md) | `orders:manage` |
| POST | `/v1/{number}/shop/orders/{id}/refund` | [Refund an order that was paid online](https://www.app2email.com/docs/api/order-and-pay/refund-shop-order.md) | `orders:manage` |
| POST | `/v1/{number}/shop/quote` | [Price a cart: total, problems, times and ways to pay](https://www.app2email.com/docs/api/order-and-pay/quote-shop-order.md) | `orders:manage` |
| GET | `/v1/{number}/shop/report` | [The shop's figures for a range of days](https://www.app2email.com/docs/api/order-and-pay/get-shop-report.md) | `orders:manage` |
| POST | `/v1/{number}/shop/link` | [A customer's personal link to the order page](https://www.app2email.com/docs/api/order-and-pay/get-shop-order-link.md) | `orders:manage` |

### Broadcasts

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

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/{number}/broadcasts` | [Your latest broadcasts](https://www.app2email.com/docs/api/broadcasts/list-broadcasts.md) | `messages:read` |
| GET | `/v1/{number}/broadcasts/{code}` | [A broadcast's status and the result per number](https://www.app2email.com/docs/api/broadcasts/get-broadcast.md) | `messages:read` |
| GET | `/v1/{number}/broadcasts/{code}/results.csv` | [A broadcast's result for each message, as CSV](https://www.app2email.com/docs/api/broadcasts/get-broadcast-csv.md) | `messages:read` |
| POST | `/v1/{number}/broadcasts/{code}/cancel` | [Cancel a scheduled or sending API broadcast](https://www.app2email.com/docs/api/broadcasts/cancel-broadcast.md) | `messages:send` |

### Contacts

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

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/{number}/contacts` | [Your contacts, newest first](https://www.app2email.com/docs/api/contacts/list-contacts.md) | `messages:read` |
| POST | `/v1/{number}/contacts` | [Make or update contacts (one, or a list of up to 1000)](https://www.app2email.com/docs/api/contacts/upsert-contacts.md) | `contacts:manage` |
| POST | `/v1/{number}/contacts/import` | [Import contacts from CSV or JSON (up to 5000 rows)](https://www.app2email.com/docs/api/contacts/import-contacts.md) | `contacts:manage` |
| GET | `/v1/{number}/contacts/export.csv` | [All contacts as CSV](https://www.app2email.com/docs/api/contacts/export-contacts.md) | `messages:read` |
| GET | `/v1/{number}/contacts/{identity}` | [One contact](https://www.app2email.com/docs/api/contacts/get-contact.md) | `messages:read` |
| PATCH | `/v1/{number}/contacts/{identity}` | [Change a contact](https://www.app2email.com/docs/api/contacts/update-contact.md) | `contacts:manage` |
| DELETE | `/v1/{number}/contacts/{identity}` | [Delete a contact record](https://www.app2email.com/docs/api/contacts/delete-contact.md) | `contacts:manage` |
| POST | `/v1/{number}/contacts/{identity}/consent` | [Record consent (or its withdrawal) with evidence](https://www.app2email.com/docs/api/contacts/record-consent.md) | `contacts:manage` |
| GET | `/v1/{number}/segments` | [Your segments (saved contact filters)](https://www.app2email.com/docs/api/contacts/list-segments.md) | `messages:read` |
| POST | `/v1/{number}/segments` | [Save a contact filter as a segment](https://www.app2email.com/docs/api/contacts/create-segment.md) | `contacts:manage` |
| GET | `/v1/{number}/segments/{id}` | [One segment, with how many contacts match now](https://www.app2email.com/docs/api/contacts/get-segment.md) | `messages:read` |
| PUT | `/v1/{number}/segments/{id}` | [Rename a segment or replace its filter](https://www.app2email.com/docs/api/contacts/update-segment.md) | `contacts:manage` |
| DELETE | `/v1/{number}/segments/{id}` | [Delete a segment (its contacts stay)](https://www.app2email.com/docs/api/contacts/delete-segment.md) | `contacts:manage` |
| GET | `/v1/{number}/segments/{id}/contacts` | [The contacts a segment matches now](https://www.app2email.com/docs/api/contacts/list-segment-contacts.md) | `messages:read` |
| GET | `/v1/{number}/blocked` | [WhatsApp users this number blocked](https://www.app2email.com/docs/api/contacts/list-blocked-users.md) | `messages:read` |
| POST | `/v1/{number}/blocked` | [Block WhatsApp users](https://www.app2email.com/docs/api/contacts/block-users.md) | `contacts:manage` |
| DELETE | `/v1/{number}/blocked` | [Unblock WhatsApp users](https://www.app2email.com/docs/api/contacts/unblock-users.md) | `contacts:manage` |
| GET | `/v1/{number}/contact-book/{bsuid}` | [Is a phone number on file for a business-scoped user id](https://www.app2email.com/docs/api/contacts/get-contact-book-entry.md) | `messages:read` |
| DELETE | `/v1/{number}/contact-book/{bsuid}` | [Remove a business-scoped user id from the contact book](https://www.app2email.com/docs/api/contacts/delete-contact-book-entry.md) | `contacts:manage` |

### Opt-ins

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

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/{number}/settings/optin` | [Is the opt-in rule for marketing on?](https://www.app2email.com/docs/api/opt-ins/get-optin-setting.md) | `settings:manage` |
| PUT | `/v1/{number}/settings/optin` | [Turn the opt-in rule for marketing on or off](https://www.app2email.com/docs/api/opt-ins/set-optin-setting.md) | `settings:manage` |
| GET | `/v1/{number}/optins` | [The opt-in records, or check one number](https://www.app2email.com/docs/api/opt-ins/list-optins.md) | `settings:manage` |
| POST | `/v1/{number}/optins` | [Record that people opted in](https://www.app2email.com/docs/api/opt-ins/add-optins.md) | `settings:manage` |
| DELETE | `/v1/{number}/optins/{phone}` | [Remove an opt-in record](https://www.app2email.com/docs/api/opt-ins/remove-optin.md) | `settings:manage` |

### Do Not Call

Numbers marketing templates are not sent to.

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/{number}/donotcall` | [The Do Not Call list, or check one number](https://www.app2email.com/docs/api/do-not-call/list-do-not-call.md) | `dnc:manage` |
| POST | `/v1/{number}/donotcall` | [Add numbers to the Do Not Call list](https://www.app2email.com/docs/api/do-not-call/add-do-not-call.md) | `dnc:manage` |
| DELETE | `/v1/{number}/donotcall/{phone}` | [Remove a number from the Do Not Call list](https://www.app2email.com/docs/api/do-not-call/remove-do-not-call.md) | `dnc:manage` |
| GET | `/v1/{number}/compliance/export.csv` | [Consent records, Do Not Call list and opt-ins as one CSV](https://www.app2email.com/docs/api/do-not-call/export-compliance.md) | `dnc:manage` |

### Approvals

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

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/{number}/approvals` | [Sends held for approval](https://www.app2email.com/docs/api/approvals/list-approvals.md) | `messages:read` |
| POST | `/v1/{number}/approvals/{id}/approve` | [Approve a held send: it is sent now](https://www.app2email.com/docs/api/approvals/approve-send.md) | `messages:send` |
| POST | `/v1/{number}/approvals/{id}/reject` | [Reject a held send: nothing is sent](https://www.app2email.com/docs/api/approvals/reject-send.md) | `messages:send` |

### Number

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

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/{number}/health` | [Number health: can it send, quality, limit, name status](https://www.app2email.com/docs/api/number/get-number-health.md) | `messages:read` |
| PUT | `/v1/{number}/settings/identity-check` | [Turn WhatsApp's identity change check on or off](https://www.app2email.com/docs/api/number/set-identity-check.md) | `settings:manage` |
| GET | `/v1/{number}/profile` | [The WhatsApp business profile](https://www.app2email.com/docs/api/number/get-business-profile.md) | `messages:read` |
| PATCH | `/v1/{number}/profile` | [Change the WhatsApp business profile](https://www.app2email.com/docs/api/number/update-business-profile.md) | `settings:manage` |
| PUT | `/v1/{number}/profile/photo` | [Change the profile photo from a public link](https://www.app2email.com/docs/api/number/set-profile-photo.md) | `settings:manage` |
| PUT | `/v1/{number}/profile/display-name` | [Submit a new display name for Meta's review](https://www.app2email.com/docs/api/number/set-display-name.md) | `settings:manage` |
| GET | `/v1/{number}/profile/official-business-account` | [Official Business Account (blue tick) status](https://www.app2email.com/docs/api/number/get-official-business-account.md) | `messages:read` |
| POST | `/v1/{number}/profile/official-business-account` | [Request an Official Business Account (blue tick)](https://www.app2email.com/docs/api/number/request-official-business-account.md) | `settings:manage` |
| GET | `/v1/{number}/profile/india-compliance` | [India business compliance information](https://www.app2email.com/docs/api/number/get-india-compliance.md) | `messages:read` |
| PUT | `/v1/{number}/profile/india-compliance` | [Set the India business compliance information](https://www.app2email.com/docs/api/number/set-india-compliance.md) | `settings:manage` |
| GET | `/v1/{number}/username` | [The business username](https://www.app2email.com/docs/api/number/get-username.md) | `messages:read` |
| PUT | `/v1/{number}/username` | [Adopt or change the business username](https://www.app2email.com/docs/api/number/set-username.md) | `settings:manage` |
| DELETE | `/v1/{number}/username` | [Remove the business username](https://www.app2email.com/docs/api/number/delete-username.md) | `settings:manage` |
| GET | `/v1/{number}/username/suggestions` | [Usernames reserved for the business](https://www.app2email.com/docs/api/number/get-username-suggestions.md) | `messages:read` |
| GET | `/v1/{number}/settings/conversation-starters` | [Ice breakers, commands and welcome message](https://www.app2email.com/docs/api/number/get-conversation-starters.md) | `messages:read` |
| PUT | `/v1/{number}/settings/conversation-starters` | [Set ice breakers, commands or the welcome message](https://www.app2email.com/docs/api/number/set-conversation-starters.md) | `settings:manage` |
| GET | `/v1/{number}/qr-codes` | [QR codes and short links](https://www.app2email.com/docs/api/number/list-qr-codes.md) | `messages:read` |
| POST | `/v1/{number}/qr-codes` | [Create a QR code and wa.me short link](https://www.app2email.com/docs/api/number/create-qr-code.md) | `settings:manage` |
| GET | `/v1/{number}/qr-codes/{code}` | [One QR code](https://www.app2email.com/docs/api/number/get-qr-code.md) | `messages:read` |
| PATCH | `/v1/{number}/qr-codes/{code}` | [Change a QR code's prefilled message](https://www.app2email.com/docs/api/number/update-qr-code.md) | `settings:manage` |
| DELETE | `/v1/{number}/qr-codes/{code}` | [Delete a QR code and its short link](https://www.app2email.com/docs/api/number/delete-qr-code.md) | `settings:manage` |
| GET | `/v1/{number}/settings/commerce` | [Cart and catalog icon on or off](https://www.app2email.com/docs/api/number/get-commerce-settings.md) | `messages:read` |
| PUT | `/v1/{number}/settings/commerce` | [Turn the cart or the catalog icon on or off](https://www.app2email.com/docs/api/number/set-commerce-settings.md) | `settings:manage` |
| GET | `/v1/{number}/catalog` | [The connected product catalog](https://www.app2email.com/docs/api/number/get-catalog.md) | `messages:read` |
| PUT | `/v1/{number}/catalog` | [Connect a product catalog](https://www.app2email.com/docs/api/number/connect-catalog.md) | `settings:manage` |

### Settings

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

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/{number}/settings/autoreply` | [The auto reply to new contacts](https://www.app2email.com/docs/api/settings/get-autoreply.md) | `settings:manage` |
| PUT | `/v1/{number}/settings/autoreply` | [Change the auto reply text](https://www.app2email.com/docs/api/settings/set-autoreply.md) | `settings:manage` |
| GET | `/v1/{number}/settings/forwarding` | [Who gets the messages by email](https://www.app2email.com/docs/api/settings/get-forwarding.md) | `settings:manage` |
| PUT | `/v1/{number}/settings/forwarding` | [Change who gets the messages by email](https://www.app2email.com/docs/api/settings/set-forwarding.md) | `settings:manage` |
| GET | `/v1/{number}/settings/number` | [The number's settings: email behaviour, caps, compliance](https://www.app2email.com/docs/api/settings/get-number-settings.md) | `messages:read` |
| PUT | `/v1/{number}/settings/number` | [Change some of the number's settings](https://www.app2email.com/docs/api/settings/update-number-settings.md) | `settings:manage` |

### Webhooks

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

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/{number}/webhooks` | [Your webhooks](https://www.app2email.com/docs/api/webhooks/list-webhooks.md) | `webhooks:manage` |
| POST | `/v1/{number}/webhooks` | [Get events at your URL](https://www.app2email.com/docs/api/webhooks/create-webhook.md) | `webhooks:manage` |
| GET | `/v1/{number}/webhooks/samples` | [A sample of every event](https://www.app2email.com/docs/api/webhooks/webhook-samples.md) | `webhooks:manage` |
| PATCH | `/v1/{number}/webhooks/{id}` | [Change a webhook: url, active, headers, format](https://www.app2email.com/docs/api/webhooks/update-webhook.md) | `webhooks:manage` |
| DELETE | `/v1/{number}/webhooks/{id}` | [Delete a webhook](https://www.app2email.com/docs/api/webhooks/delete-webhook.md) | `webhooks:manage` |
| POST | `/v1/{number}/webhooks/{id}/test` | [Send a test event now](https://www.app2email.com/docs/api/webhooks/test-webhook.md) | `webhooks:manage` |
| POST | `/v1/{number}/webhooks/{id}/rotate-secret` | [Make a new signing secret](https://www.app2email.com/docs/api/webhooks/rotate-webhook-secret.md) | `webhooks:manage` |
| GET | `/v1/{number}/webhooks/{id}/deliveries` | [The last deliveries, with every attempt](https://www.app2email.com/docs/api/webhooks/list-webhook-deliveries.md) | `webhooks:manage` |
| GET | `/v1/{number}/webhooks/{id}/deliveries/{event_id}` | [One delivery, with the event as it was sent](https://www.app2email.com/docs/api/webhooks/get-webhook-delivery.md) | `webhooks:manage` |
| POST | `/v1/{number}/webhooks/{id}/deliveries/{event_id}/redeliver` | [Send a stored event again](https://www.app2email.com/docs/api/webhooks/redeliver-webhook-event.md) | `webhooks:manage` |
| GET | `/v1/{number}/events` | [Fetch events (no webhook address needed)](https://www.app2email.com/docs/api/webhooks/list-events.md) | `messages:read` |
| POST | `/v1/{number}/webhooks/test-url` | [Send a test event to any URL](https://www.app2email.com/docs/api/webhooks/test-webhook-url.md) | `webhooks:manage` |
| GET | `/v1/{number}/webhooks/catchers` | [Your catchers](https://www.app2email.com/docs/api/webhooks/list-webhook-catchers.md) | `webhooks:manage` |
| POST | `/v1/{number}/webhooks/catchers` | [Get a temporary URL that keeps what it receives](https://www.app2email.com/docs/api/webhooks/create-webhook-catcher.md) | `webhooks:manage` |
| GET | `/v1/{number}/webhooks/catchers/{token}` | [What a catcher received](https://www.app2email.com/docs/api/webhooks/get-webhook-catcher.md) | `webhooks:manage` |
| DELETE | `/v1/{number}/webhooks/catchers/{token}` | [Delete a catcher](https://www.app2email.com/docs/api/webhooks/delete-webhook-catcher.md) | `webhooks:manage` |

### Analytics

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

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/{number}/analytics/pricing` | [WhatsApp cost and volume of this number](https://www.app2email.com/docs/api/analytics/get-pricing-analytics.md) | `messages:read` |
| GET | `/v1/{number}/analytics/messages` | [Messages sent and delivered, as WhatsApp counts them](https://www.app2email.com/docs/api/analytics/get-message-analytics.md) | `messages:read` |
| GET | `/v1/{number}/activity` | [The WhatsApp Business Account's activity log](https://www.app2email.com/docs/api/analytics/get-account-activity.md) | `messages:read` |
| GET | `/v1/{number}/conversions/dataset` | [The Conversions API dataset of the account](https://www.app2email.com/docs/api/analytics/get-conversions-dataset.md) | `messages:read` |
| POST | `/v1/{number}/conversions/dataset` | [Create the Conversions API dataset](https://www.app2email.com/docs/api/analytics/create-conversions-dataset.md) | `settings:manage` |
| GET | `/v1/{number}/conversions/dataset/quality` | [Quality of the Conversions API dataset](https://www.app2email.com/docs/api/analytics/get-conversions-dataset-quality.md) | `messages:read` |
| POST | `/v1/{number}/conversions/events` | [Send conversion events of WhatsApp chats](https://www.app2email.com/docs/api/analytics/send-conversion-events.md) | `messages:send` |

### Calling

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

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/{number}/calling/settings` | [WhatsApp calling settings](https://www.app2email.com/docs/api/calling/get-call-settings.md) | `calls:manage` |
| PATCH | `/v1/{number}/calling/settings` | [Change the calling settings](https://www.app2email.com/docs/api/calling/update-call-settings.md) | `calls:manage` |
| POST | `/v1/{number}/calls` | [Start, answer, reject or end a WhatsApp call](https://www.app2email.com/docs/api/calling/manage-call.md) | `calls:manage` |
| GET | `/v1/{number}/calls/permissions/{contact}` | [May the number call this contact](https://www.app2email.com/docs/api/calling/get-call-permission.md) | `calls:manage` |

### Account

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

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/{number}/me` | [Check the key: its scopes, the number, the plan and the limits](https://www.app2email.com/docs/api/account/get-me.md) | any valid key |
| GET | `/v1/{number}/requests` | [The latest logged API requests](https://www.app2email.com/docs/api/account/list-requests.md) | `messages:read` |
| GET | `/v1/{number}/requests/{id}` | [One logged request, by its request_id](https://www.app2email.com/docs/api/account/get-request.md) | `messages:read` |
| GET | `/v1/{number}/usage/history` | [Messages and broadcasts per month](https://www.app2email.com/docs/api/account/get-usage-history.md) | `messages:read` |
| GET | `/v1/{number}/stats` | [Message counts, delivery and read rates for a period](https://www.app2email.com/docs/api/account/get-stats.md) | `messages:read` |
| GET | `/v1/{number}/usage` | [Plan, messages used and left, limits, what WhatsApp charges](https://www.app2email.com/docs/api/account/get-usage.md) | `messages:read` |
| GET | `/v1/{number}/usage/meta` | [What WhatsApp charges this billing month, per day](https://www.app2email.com/docs/api/account/get-usage-meta.md) | `messages:read` |

### Account management

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.

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| POST | `/v1/account/sandbox` | [Instant sandbox: try the API with no account](https://www.app2email.com/docs/api/account-management/create-sandbox.md) | any valid key |
| POST | `/v1/account/signup` | [Start an account for a person (agent sign-up)](https://www.app2email.com/docs/api/account-management/create-account.md) | any valid key |
| GET | `/v1/account` | [Account status and what is still needed](https://www.app2email.com/docs/api/account-management/get-account.md) | any valid key |
| GET | `/v1/account/plans` | [Plans that can be bought](https://www.app2email.com/docs/api/account-management/list-account-plans.md) | any valid key |
| GET | `/v1/account/estimate` | [Cost estimate for a number of messages a month](https://www.app2email.com/docs/api/account-management/estimate-cost.md) | any valid key |
| GET | `/v1/account/numbers` | [The account's WhatsApp numbers](https://www.app2email.com/docs/api/account-management/list-account-numbers.md) | `account:read` |
| GET | `/v1/account/numbers/{number}` | [One number of the account](https://www.app2email.com/docs/api/account-management/get-account-number.md) | `account:read` |
| GET | `/v1/account/numbers/{number}/keys` | [The keys of a number](https://www.app2email.com/docs/api/account-management/list-number-keys.md) | `keys:manage` |
| POST | `/v1/account/numbers/{number}/keys` | [Create a key for a number](https://www.app2email.com/docs/api/account-management/create-number-key.md) | `keys:manage` |
| DELETE | `/v1/account/numbers/{number}/keys/{key_id}` | [Revoke a key of a number](https://www.app2email.com/docs/api/account-management/revoke-number-key.md) | `keys:manage` |
| POST | `/v1/account/numbers/{number}/checkout` | [Payment link for a plan of a number](https://www.app2email.com/docs/api/account-management/create-number-checkout.md) | `account:manage` |
| GET | `/v1/account/usage` | [Messages used this billing month, per number](https://www.app2email.com/docs/api/account-management/get-account-usage.md) | `billing:read` |
| GET | `/v1/account/keys` | [Account keys](https://www.app2email.com/docs/api/account-management/list-account-keys.md) | `account:manage` |
| POST | `/v1/account/keys` | [Create an account key](https://www.app2email.com/docs/api/account-management/create-account-key.md) | `account:manage` |
| DELETE | `/v1/account/keys/{key_id}` | [Revoke an account key](https://www.app2email.com/docs/api/account-management/revoke-account-key.md) | `account:manage` |
| GET | `/v1/account/webhooks` | [Account webhooks](https://www.app2email.com/docs/api/account-management/list-account-webhooks.md) | `webhooks:manage` |
| POST | `/v1/account/webhooks` | [Add an account webhook](https://www.app2email.com/docs/api/account-management/create-account-webhook.md) | `webhooks:manage` |
| PATCH | `/v1/account/webhooks/{id}` | [Change an account webhook](https://www.app2email.com/docs/api/account-management/update-account-webhook.md) | `webhooks:manage` |
| DELETE | `/v1/account/webhooks/{id}` | [Delete an account webhook](https://www.app2email.com/docs/api/account-management/delete-account-webhook.md) | `webhooks:manage` |
| POST | `/v1/account/webhooks/{id}/test` | [Send a test event to an account webhook](https://www.app2email.com/docs/api/account-management/test-account-webhook.md) | `webhooks:manage` |
| POST | `/v1/account/webhooks/{id}/rotate-secret` | [New signing secret for an account webhook](https://www.app2email.com/docs/api/account-management/rotate-account-webhook-secret.md) | `webhooks:manage` |
| GET | `/v1/account/webhooks/{id}/deliveries` | [Deliveries of an account webhook](https://www.app2email.com/docs/api/account-management/list-account-webhook-deliveries.md) | `webhooks:manage` |
| GET | `/v1/account/webhooks/{id}/deliveries/{event_id}` | [One delivery of an account webhook](https://www.app2email.com/docs/api/account-management/get-account-webhook-delivery.md) | `webhooks:manage` |
| POST | `/v1/account/webhooks/{id}/deliveries/{event_id}/redeliver` | [Send a stored event again to an account webhook](https://www.app2email.com/docs/api/account-management/redeliver-account-webhook-event.md) | `webhooks:manage` |

### Partner

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

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/partner` | [The partner account](https://www.app2email.com/docs/api/partner/get-partner.md) | `partner:read` |
| PATCH | `/v1/partner` | [Change the partner settings](https://www.app2email.com/docs/api/partner/update-partner.md) | `partner:manage` |
| GET | `/v1/partner/clients` | [Clients](https://www.app2email.com/docs/api/partner/list-partner-clients.md) | `partner:read` |
| POST | `/v1/partner/clients` | [Create a client](https://www.app2email.com/docs/api/partner/create-partner-client.md) | `clients:manage` |
| GET | `/v1/partner/clients/{client_id}` | [One client](https://www.app2email.com/docs/api/partner/get-partner-client.md) | `partner:read` |
| PATCH | `/v1/partner/clients/{client_id}` | [Change a client](https://www.app2email.com/docs/api/partner/update-partner-client.md) | `clients:manage` |
| GET | `/v1/partner/clients/{client_id}/usage` | [Usage of a client](https://www.app2email.com/docs/api/partner/get-partner-client-usage.md) | `billing:read` |
| GET | `/v1/partner/numbers` | [Numbers of your clients](https://www.app2email.com/docs/api/partner/list-partner-numbers.md) | `partner:read` |
| GET | `/v1/partner/numbers/{number}` | [One number](https://www.app2email.com/docs/api/partner/get-partner-number.md) | `partner:read` |
| GET | `/v1/partner/numbers/{number}/usage` | [Usage of a number](https://www.app2email.com/docs/api/partner/get-partner-number-usage.md) | `billing:read` |
| GET | `/v1/partner/numbers/{number}/keys` | [Keys of a number](https://www.app2email.com/docs/api/partner/list-partner-number-keys.md) | `keys:manage` |
| POST | `/v1/partner/numbers/{number}/keys` | [Create a key for a client's number](https://www.app2email.com/docs/api/partner/create-partner-number-key.md) | `keys:manage` |
| DELETE | `/v1/partner/numbers/{number}/keys/{key_id}` | [Revoke a key of a client's number](https://www.app2email.com/docs/api/partner/revoke-partner-number-key.md) | `keys:manage` |
| POST | `/v1/partner/onboarding-links` | [Onboarding link for a new or existing client](https://www.app2email.com/docs/api/partner/create-onboarding-link.md) | `clients:manage` |
| GET | `/v1/partner/payments` | [Client payments](https://www.app2email.com/docs/api/partner/list-partner-payments.md) | `billing:read` |
| GET | `/v1/partner/subscriptions` | [Client plans](https://www.app2email.com/docs/api/partner/list-partner-subscriptions.md) | `billing:read` |
| GET | `/v1/partner/webhooks` | [Partner webhooks](https://www.app2email.com/docs/api/partner/list-partner-webhooks.md) | `webhooks:manage` |
| POST | `/v1/partner/webhooks` | [Add a partner webhook](https://www.app2email.com/docs/api/partner/create-partner-webhook.md) | `webhooks:manage` |
| PATCH | `/v1/partner/webhooks/{id}` | [Change a partner webhook](https://www.app2email.com/docs/api/partner/update-partner-webhook.md) | `webhooks:manage` |
| DELETE | `/v1/partner/webhooks/{id}` | [Delete a partner webhook](https://www.app2email.com/docs/api/partner/delete-partner-webhook.md) | `webhooks:manage` |
| POST | `/v1/partner/webhooks/{id}/test` | [Send a test event to a partner webhook](https://www.app2email.com/docs/api/partner/test-partner-webhook.md) | `webhooks:manage` |
| POST | `/v1/partner/webhooks/{id}/rotate-secret` | [New signing secret for a partner webhook](https://www.app2email.com/docs/api/partner/rotate-partner-webhook-secret.md) | `webhooks:manage` |
| GET | `/v1/partner/webhooks/{id}/deliveries` | [Deliveries of a partner webhook](https://www.app2email.com/docs/api/partner/list-partner-webhook-deliveries.md) | `webhooks:manage` |
| GET | `/v1/partner/webhooks/{id}/deliveries/{event_id}` | [One delivery of a partner webhook](https://www.app2email.com/docs/api/partner/get-partner-webhook-delivery.md) | `webhooks:manage` |
| POST | `/v1/partner/webhooks/{id}/deliveries/{event_id}/redeliver` | [Send a stored event again to a partner webhook](https://www.app2email.com/docs/api/partner/redeliver-partner-webhook-event.md) | `webhooks:manage` |

### Calendar

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.

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| PATCH | `/v1/{number}/bookings/{id}` | [Change an appointment's details](https://www.app2email.com/docs/api/calendar/update-booking.md) | `bookings:manage` |
| GET | `/v1/{number}/calendar` | [Everything on the calendar for a range of days](https://www.app2email.com/docs/api/calendar/get-calendar.md) | `bookings:manage\|messages:read` |
| GET | `/v1/{number}/calendar/blocks` | [The blocked times](https://www.app2email.com/docs/api/calendar/list-calendar-blocks.md) | `bookings:manage\|messages:read` |
| POST | `/v1/{number}/calendar/blocks` | [Block time so that no one can book it](https://www.app2email.com/docs/api/calendar/create-calendar-block.md) | `bookings:manage` |
| PATCH | `/v1/{number}/calendar/blocks/{id}` | [Change a blocked time](https://www.app2email.com/docs/api/calendar/update-calendar-block.md) | `bookings:manage` |
| DELETE | `/v1/{number}/calendar/blocks/{id}` | [Remove a blocked time](https://www.app2email.com/docs/api/calendar/delete-calendar-block.md) | `bookings:manage` |
| GET | `/v1/{number}/bookings/services` | [The services a customer can book, and their staff](https://www.app2email.com/docs/api/calendar/list-bookable-services.md) | `bookings:manage\|messages:read` |
| GET | `/v1/{number}/bookings/staff` | [The staff members and the services they do](https://www.app2email.com/docs/api/calendar/list-booking-staff.md) | `bookings:manage\|messages:read` |
| GET | `/v1/{number}/bookings/next` | [The next free start times for a service, across days](https://www.app2email.com/docs/api/calendar/get-next-booking-slots.md) | `bookings:manage\|messages:read` |
| POST | `/v1/{number}/bookings/{id}/reschedule` | [Move an appointment to another time](https://www.app2email.com/docs/api/calendar/reschedule-booking.md) | `bookings:manage` |
| GET | `/v1/{number}/bookings/{id}/notes` | [The internal notes of an appointment and its customer](https://www.app2email.com/docs/api/calendar/list-booking-notes.md) | `bookings:manage\|messages:read` |
| POST | `/v1/{number}/bookings/{id}/notes` | [Add an internal note to an appointment](https://www.app2email.com/docs/api/calendar/add-booking-note.md) | `bookings:manage` |
| GET | `/v1/{number}/bookings/notes` | [The internal notes of a customer](https://www.app2email.com/docs/api/calendar/list-customer-notes.md) | `bookings:manage\|messages:read` |
| POST | `/v1/{number}/bookings/notes` | [Add an internal note to a customer](https://www.app2email.com/docs/api/calendar/add-customer-note.md) | `bookings:manage` |
| DELETE | `/v1/{number}/bookings/notes/{note_id}` | [Delete an internal note](https://www.app2email.com/docs/api/calendar/delete-booking-note.md) | `bookings:manage` |
| GET | `/v1/{number}/bookings/links` | [The personal booking links](https://www.app2email.com/docs/api/calendar/list-booking-links.md) | `bookings:manage\|messages:read` |
| POST | `/v1/{number}/bookings/links` | [Make a link that opens the online booking page](https://www.app2email.com/docs/api/calendar/create-booking-link.md) | `bookings:manage` |
| DELETE | `/v1/{number}/bookings/links/{code}` | [Revoke a personal booking link](https://www.app2email.com/docs/api/calendar/revoke-booking-link.md) | `bookings:manage` |
| POST | `/v1/{number}/bookings/holds` | [Keep a free time for a few minutes](https://www.app2email.com/docs/api/calendar/create-booking-hold.md) | `bookings:manage` |
| DELETE | `/v1/{number}/bookings/holds/{reference}` | [Release a held time](https://www.app2email.com/docs/api/calendar/release-booking-hold.md) | `bookings:manage` |

### Payments

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.

| Method | Path | Summary | Scope |
| --- | --- | --- | --- |
| GET | `/v1/{number}/payments` | [The payments, newest first](https://www.app2email.com/docs/api/payments/list-payments.md) | `bookings:manage\|messages:read` |
| GET | `/v1/{number}/payments/{id}` | [One payment](https://www.app2email.com/docs/api/payments/get-payment.md) | `bookings:manage\|messages:read` |
| POST | `/v1/{number}/payments/links` | [Ask a customer to pay an amount](https://www.app2email.com/docs/api/payments/create-payment-link.md) | `bookings:manage` |
| POST | `/v1/{number}/payments/{id}/refund` | [Refund a payment, in full or a part](https://www.app2email.com/docs/api/payments/refund-payment.md) | `bookings:manage` |
| POST | `/v1/{number}/bookings/{id}/payment` | [Record a payment taken outside app2email](https://www.app2email.com/docs/api/payments/set-booking-payment.md) | `bookings:manage` |
| GET | `/v1/{number}/bookings/packages` | [The prepaid packages on sale](https://www.app2email.com/docs/api/payments/list-packages.md) | `bookings:manage\|messages:read` |
| GET | `/v1/{number}/bookings/packages/purchases` | [The packages customers hold](https://www.app2email.com/docs/api/payments/list-package-purchases.md) | `bookings:manage\|messages:read` |
| POST | `/v1/{number}/bookings/packages/grant` | [Give a customer a package without a payment](https://www.app2email.com/docs/api/payments/grant-package.md) | `bookings:manage` |
| GET | `/v1/{number}/bookings/customers` | [The customers with appointments](https://www.app2email.com/docs/api/payments/list-booking-customers.md) | `bookings:manage\|messages:read` |
| GET | `/v1/{number}/bookings/customers/{contact}` | [A customer's whole profile](https://www.app2email.com/docs/api/payments/get-customer-profile.md) | `bookings:manage\|messages:read` |
| PATCH | `/v1/{number}/bookings/customers/{contact}` | [Change a customer's name, e-mail, tags or fields](https://www.app2email.com/docs/api/payments/update-customer.md) | `bookings:manage` |
| DELETE | `/v1/{number}/bookings/customers/{contact}` | [Erase a customer's booking data](https://www.app2email.com/docs/api/payments/erase-customer-booking-data.md) | `bookings:manage` |
| GET | `/v1/{number}/bookings/polls` | [The meeting polls](https://www.app2email.com/docs/api/payments/list-polls.md) | `bookings:manage\|messages:read` |
| POST | `/v1/{number}/bookings/polls` | [Offer several times and let people vote](https://www.app2email.com/docs/api/payments/create-poll.md) | `bookings:manage` |
| GET | `/v1/{number}/bookings/polls/{id}` | [One poll with its votes](https://www.app2email.com/docs/api/payments/get-poll.md) | `bookings:manage\|messages:read` |
| POST | `/v1/{number}/bookings/polls/{id}/close` | [Close a poll to new votes](https://www.app2email.com/docs/api/payments/close-poll.md) | `bookings:manage` |
| POST | `/v1/{number}/bookings/polls/{id}/book` | [Pick the winning time](https://www.app2email.com/docs/api/payments/book-poll.md) | `bookings:manage` |

## Pages

- [Sandbox](https://www.app2email.com/docs/api/sandbox.md)
- [Errors](https://www.app2email.com/docs/api/errors.md)
- [Limits](https://www.app2email.com/docs/api/limits.md)
- [Message types](https://www.app2email.com/docs/api/message-types.md)
- [Webhooks](https://www.app2email.com/docs/api/webhooks.md)
- [Webhook tester](https://www.app2email.com/docs/api/webhooks/tester.md)
- [Console](https://www.app2email.com/docs/api/console.md)
- [MCP server](https://www.app2email.com/docs/api/mcp.md)
- [Management MCP (agents)](https://www.app2email.com/docs/api/agents.md)
