# MCP server

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

URL: `https://api.app2email.com/mcp` (Streamable HTTP; protocol 2026-07-28, 2025-11-25, 2025-06-18, 2025-03-26, 2024-11-05)

Auth: `Authorization: Bearer <number API key>`. Keys: https://www.app2email.com/dashboard/apikey; a sandbox key sends nothing to WhatsApp.

## Install

### Claude Code

https://code.claude.com/docs/en/mcp

```shell
claude mcp add --transport http app2email https://api.app2email.com/mcp --header "Authorization: Bearer YOUR_API_KEY"
```

### .mcp.json

https://code.claude.com/docs/en/mcp

```json
{
  "mcpServers": {
    "app2email": {
      "type": "http",
      "url": "https://api.app2email.com/mcp",
      "headers": {
        "Authorization": "Bearer ${APP2EMAIL_API_KEY}"
      }
    }
  }
}
```

### claude.ai

Customize → Connectors → + Add → Add custom connector. (https://support.claude.com/en/articles/11175166-get-started-with-custom-connectors-using-remote-mcp)

```text
URL:             https://api.app2email.com/mcp
Authentication:  OAuth (you sign in to app2email and choose the number)

Or with a key:   Authentication: No sign in
                 Request header: Authorization: Bearer YOUR_API_KEY
```

### Cursor

~/.cursor/mcp.json (https://cursor.com/docs/context/mcp)

```json
{
  "mcpServers": {
    "app2email": {
      "url": "https://api.app2email.com/mcp",
      "headers": {
        "Authorization": "Bearer ${env:APP2EMAIL_API_KEY}"
      }
    }
  }
}
```

### VS Code

.vscode/mcp.json (https://code.visualstudio.com/docs/agents/reference/mcp-configuration)

```json
{
  "inputs": [
    {
      "type": "promptString",
      "id": "app2email-key",
      "description": "app2email API key",
      "password": true
    }
  ],
  "servers": {
    "app2email": {
      "type": "http",
      "url": "https://api.app2email.com/mcp",
      "headers": {
        "Authorization": "Bearer ${input:app2email-key}"
      }
    }
  }
}
```

### Codex

~/.codex/config.toml, with APP2EMAIL_API_KEY set in the environment. (https://learn.chatgpt.com/docs/extend/mcp?surface=cli)

```toml
[mcp_servers.app2email]
url = "https://api.app2email.com/mcp"
bearer_token_env_var = "APP2EMAIL_API_KEY"
```

### ChatGPT

Developer mode: add the server as a connector with OAuth; you sign in to app2email and choose the number.

```text
URL:             https://api.app2email.com/mcp
Authentication:  OAuth
```

## Test

Ask: "Check my app2email key and list my approved templates." Expected: `check_key` → `list_templates`.

## Sign in with OAuth

A client with OAuth (claude.ai, ChatGPT, Claude Code, VS Code, Cursor) needs no key: it connects without one, the person signs in to app2email, chooses the WhatsApp number, what the app may do and whether it is a sandbox. The app then holds a key of that number; it shows on the API key page as "OAuth: <app>" and is revoked there. OAuth 2.1 with PKCE and dynamic client registration; metadata: https://api.app2email.com/.well-known/oauth-protected-resource/mcp and https://www.app2email.com/.well-known/oauth-authorization-server.

## Smaller tool lists

The same server with fewer tools, for clients with a tool limit and small models: connect `https://api.app2email.com/mcp/<set>`, or several sets with `https://api.app2email.com/mcp?tools=<set>,<set>`. Every tool can still be called by name.

| Set | URL | Tools |
| --- | --- | --- |
| Messaging | `https://api.app2email.com/mcp/messaging` | 16: check_key, send_text, send_template, send_media, send_interactive, mark_read, list_messages, get_message, list_templates, get_template, list_conversations, get_conversation_messages, set_conversation_owner, list_events, wait_for_message, upload_media |
| Messages | `https://api.app2email.com/mcp/messages` | 12: check_key, send_template, send_text, send_media, send_interactive, get_message, list_messages, send_message, send_reaction, send_location, mark_read, get_marketing_status |
| Media | `https://api.app2email.com/mcp/media` | 4: check_key, upload_media, get_media_info, delete_media |
| Conversations | `https://api.app2email.com/mcp/conversations` | 5: check_key, list_conversations, get_conversation, get_conversation_messages, set_conversation_owner |
| Templates | `https://api.app2email.com/mcp/templates` | 15: check_key, list_templates, get_template, create_template, edit_template, delete_template, delete_templates, archive_template, unarchive_template, compare_templates, list_template_library, upsert_auth_template, preview_auth_templates, get_template_insights, enable_template_insights |
| Broadcasts | `https://api.app2email.com/mcp/broadcasts` | 4: check_key, list_broadcasts, get_broadcast, cancel_broadcast |
| Account | `https://api.app2email.com/mcp/account` | 2: check_key, get_usage |
| Do Not Call | `https://api.app2email.com/mcp/do-not-call` | 4: check_key, list_donotcall, add_donotcall, remove_donotcall |
| Contacts | `https://api.app2email.com/mcp/contacts` | 8: check_key, list_contacts, upsert_contact, list_blocked_users, block_users, unblock_users, check_contact_book, delete_contact_book_entry |
| Approvals | `https://api.app2email.com/mcp/approvals` | 3: check_key, list_approvals, approve_send |
| Webhooks | `https://api.app2email.com/mcp/webhooks` | 10: check_key, list_events, wait_for_message, list_webhooks, create_webhook, update_webhook, delete_webhook, test_webhook_url, create_webhook_catcher, get_webhook_catcher |
| Analytics | `https://api.app2email.com/mcp/analytics` | 4: check_key, get_pricing_analytics, get_message_analytics, get_account_activity |
| Book-and-Pay | `https://api.app2email.com/mcp/book-and-pay` | 13: check_key, list_bookings, get_booking_availability, create_booking, cancel_booking, set_booking_status, get_booking_settings, update_booking_settings, get_booking_reports, send_flow, list_waitlist, add_to_waitlist, remove_from_waitlist |
| Calendar | `https://api.app2email.com/mcp/calendar` | 12: check_key, get_calendar, list_booking_services, find_next_booking_slots, update_booking, reschedule_booking, list_booking_notes, add_booking_note, create_time_block, delete_time_block, create_booking_link, hold_booking_slot |
| Calling | `https://api.app2email.com/mcp/calling` | 3: check_key, get_call_settings, get_call_permission |
| Flows | `https://api.app2email.com/mcp/flows` | 12: check_key, list_flows, get_flow, create_flow, update_flow, get_flow_json, update_flow_json, publish_flow, deprecate_flow, delete_flow, get_flow_preview, renew_flow_preview |
| Number | `https://api.app2email.com/mcp/number` | 14: check_key, get_number_health, get_profile, update_profile, set_profile_photo, set_display_name, get_username, set_username, get_conversation_starters, set_conversation_starters, list_qr_codes, create_qr_code, update_qr_code, delete_qr_code |
| Payments | `https://api.app2email.com/mcp/payments` | 7: check_key, get_customer_profile, list_payments, request_payment, refund_payment, create_meeting_poll, erase_customer_data |
| Order-and-Pay | `https://api.app2email.com/mcp/order-and-pay` | 20: check_key, get_shop, get_shop_settings, update_shop_settings, list_shop_categories, search_shop_items, get_shop_item, create_shop_item, update_shop_item, archive_shop_item, set_shop_stock, set_shop_sold_out, list_shop_orders, get_shop_order, update_shop_order, refund_shop_order, quote_shop_order, create_shop_order, get_shop_report, get_shop_order_link |
| Submit-Info | `https://api.app2email.com/mcp/submit-info` | 43: check_key, list_automations, get_automation, create_automation, update_automation, delete_automation, try_automation, list_automation_runs, run_submission_action, list_connections, set_connection, delete_connection, test_connection, refresh_connection, list_connection_functions, get_submit_guide, get_submit_settings, update_submit_settings, apply_submit_setup, list_submit_presets, list_forms, create_form, get_form, update_form, delete_form, publish_form, send_form, list_submit_lists, set_submit_list, delete_submit_list, list_submissions, get_submission, create_submission, update_submission, add_submission_note, reply_to_submission, add_submission_file, delete_submission, list_submit_members, invite_submit_member, update_submit_member, remove_submit_member, get_submit_report |
| Tickets-and-Pay | `https://api.app2email.com/mcp/tickets-and-pay` | 13: check_key, list_ticket_events, get_ticket_event, get_ticket_availability, list_ticket_orders, get_ticket_order, create_ticket_order, refund_ticket_order, resend_tickets, list_tickets, check_in_ticket, get_ticket_stats, list_ticket_waitlist |
| Search, then call | `https://api.app2email.com/mcp/search` | 2: find_tools, call_tool |

## Tools

| Tool | What | Kind |
| --- | --- | --- |
| `check_key` | Check the key: its scopes, the number, the plan and the limits. | read-only |
| `list_templates` | List your templates, with an example request for each. | read-only |
| `get_template` | One template: status, rejection reason, what it needs. | read-only |
| `send_template` | Send an approved WhatsApp template to one number, a list of numbers, or a saved segment of contacts. | destructive |
| `send_text` | Send a free-form text message to ONE contact. | destructive |
| `send_media` | Send a free-form image, video or document by public link to ONE contact, within the 24 hour reply window (otherwise 422 outside_24h_window: use a template with… | destructive |
| `send_interactive` | Send an interactive message (reply buttons, a list, or a call-to-action URL button) to ONE contact within the 24 hour reply window. | destructive |
| `get_message` | Status of a sent message. | read-only |
| `list_messages` | Messages sent and received, newest first. | read-only |
| `list_conversations` | The contacts, most recent activity first. | read-only |
| `list_events` | The number's events (message.received, message.status, contact.opted_out and the rest: the same JSON a webhook gets, with the same ids), fetched instead of pus… | read-only |
| `wait_for_message` | Waits (up to 25 seconds) for messages contacts sent to the number and returns them as message.received events: who wrote, the text, the message_id. | read-only |
| `get_conversation` | One contact's conversation: window_state (open: a free-form reply can be sent now; closed: use a template), window_closes_at, the owner ("" = default routing, … | read-only |
| `get_conversation_messages` | One contact's messages, both directions. | read-only |
| `set_conversation_owner` | Set who owns a contact's conversation. | destructive |
| `list_contacts` | The number's contacts (name, tags, custom fields, marketing consent, last message times). | read-only |
| `upsert_contact` | Create a contact, or update the one with this identity: name, tags, custom fields (used as template values in segment sends) and marketing consent with its evi… | destructive |
| `get_usage` | Plan, messages used and left, limits, what WhatsApp charges. | read-only |
| `list_broadcasts` | Your latest broadcasts. | read-only |
| `get_broadcast` | A broadcast's status and the result per number. | read-only |
| `cancel_broadcast` | Cancel a scheduled or sending API broadcast. | destructive |
| `list_donotcall` | The Do Not Call list, or check one number. | read-only |
| `add_donotcall` | Add numbers to the Do Not Call list. | destructive |
| `remove_donotcall` | Remove a number from the Do Not Call list. | destructive |
| `list_approvals` | Sends held for approval: a key with an approval threshold (approval_above) holds any send to more numbers than that until a person approves it on the dashboard… | read-only |
| `approve_send` | Approve a send that is waiting (list_approvals): the messages go out now. | destructive |
| `list_bookings` | The appointments, soonest start first. | read-only |
| `get_booking_availability` | The free slots per day for a service, as the customer would see them. | read-only |
| `create_booking` | Book an appointment for a customer at a free slot. | destructive |
| `cancel_booking` | Cancel an appointment. | destructive |
| `set_booking_status` | Mark an appointment completed, a no-show, or back to confirmed. | destructive |
| `get_booking_settings` | The booking settings, the default Flow's status and every Flow. | read-only |
| `update_booking_settings` | Switch Book-and-Pay on or off and change the settings. | destructive |
| `get_booking_reports` | The booking report of a range of days. | read-only |
| `send_flow` | Send a Flow to a contact (the booking form or another form). | destructive |
| `get_calendar` | Everything on the calendar for a range of days. | read-only |
| `list_booking_services` | The services a customer can book, and their staff. | read-only |
| `find_next_booking_slots` | The next free start times for a service, across days. | read-only |
| `update_booking` | Change an appointment's details. | destructive |
| `reschedule_booking` | Move an appointment to another time. | destructive |
| `list_booking_notes` | The internal notes of an appointment and its customer. | read-only |
| `add_booking_note` | Add an internal note to an appointment. | destructive |
| `create_time_block` | Block time so that no one can book it. | destructive |
| `delete_time_block` | Remove a blocked time. | destructive |
| `create_booking_link` | Make a link that opens the online booking page. | destructive |
| `hold_booking_slot` | Keep a free time for a few minutes. | destructive |
| `get_customer_profile` | A customer's whole profile. | read-only |
| `list_payments` | The payments, newest first. | read-only |
| `request_payment` | Ask a customer to pay an amount. | destructive |
| `refund_payment` | Refund a payment, in full or a part. | destructive |
| `create_meeting_poll` | Offer several times and let people vote. | destructive |
| `erase_customer_data` | Erase a customer's booking data. | destructive |
| `get_pricing_analytics` | WhatsApp cost and volume of this number. | read-only |
| `get_message_analytics` | Messages sent and delivered, as WhatsApp counts them. | read-only |
| `get_account_activity` | The WhatsApp Business Account's activity log. | read-only |
| `list_waitlist` | The waitlist of full days. | read-only |
| `add_to_waitlist` | Put a customer on the waitlist of a full day. | destructive |
| `remove_from_waitlist` | Take a customer off the waitlist. | destructive |
| `get_call_settings` | WhatsApp calling settings. | read-only |
| `get_call_permission` | May the number call this contact. | read-only |
| `list_flows` | List WhatsApp Flows. | read-only |
| `get_flow` | One flow: status, validation errors, health. | read-only |
| `create_flow` | Create a flow (draft, or published at once). | destructive |
| `update_flow` | Change a flow's name, categories or endpoint. | destructive |
| `get_flow_json` | A flow's Flow JSON. | read-only |
| `update_flow_json` | Replace a flow's Flow JSON. | destructive |
| `publish_flow` | Publish a flow (cannot be undone). | destructive |
| `deprecate_flow` | Deprecate a published flow (cannot be undone). | destructive |
| `delete_flow` | Delete a draft flow. | destructive |
| `get_flow_preview` | A public preview link of a flow (30 days). | read-only |
| `renew_flow_preview` | A new preview link of a flow (the old one stops working). | destructive |
| `upload_media` | Upload a file once, get a media id. | destructive |
| `get_media_info` | The type, size and sha256 of a received file (message_id) or a WhatsApp media id, and whether app2email has its own copy (source stored) or it comes from Whats… | read-only |
| `delete_media` | Delete an uploaded file at WhatsApp. | destructive |
| `get_number_health` | Number health: can it send, quality, limit, name status. | read-only |
| `get_profile` | The WhatsApp business profile. | read-only |
| `update_profile` | Change the WhatsApp business profile. | destructive |
| `set_profile_photo` | Change the profile photo from a public link. | destructive |
| `set_display_name` | Submit a new display name for Meta's review. | destructive |
| `get_username` | The business username. | read-only |
| `set_username` | Adopt or change the business username. | destructive |
| `get_conversation_starters` | Ice breakers, commands and welcome message. | read-only |
| `set_conversation_starters` | Set ice breakers, commands or the welcome message. | destructive |
| `list_qr_codes` | QR codes and short links. | read-only |
| `create_qr_code` | Create a QR code and wa.me short link. | destructive |
| `update_qr_code` | Change a QR code's prefilled message. | destructive |
| `delete_qr_code` | Delete a QR code and its short link. | destructive |
| `send_message` | Send a free-form WhatsApp message of any type to ONE contact within the 24 hour reply window: audio (voice: true for a voice note, Ogg/OPUS), sticker (WebP), l… | destructive |
| `send_reaction` | Put an emoji reaction on one of the contact's messages (up to 30 days old), within the 24 hour reply window. | destructive |
| `send_location` | Send a map pin to ONE contact within the 24 hour reply window. | destructive |
| `mark_read` | Mark a received message as read, optionally typing. | destructive |
| `get_marketing_status` | Where marketing templates go: Cloud API or Marketing Messages API. | read-only |
| `list_blocked_users` | WhatsApp users this number blocked. | read-only |
| `block_users` | Block WhatsApp users. | destructive |
| `unblock_users` | Unblock WhatsApp users. | destructive |
| `check_contact_book` | Is a phone number on file for a business-scoped user id. | read-only |
| `delete_contact_book_entry` | Remove a business-scoped user id from the contact book. | destructive |
| `get_shop` | The shop: on or off, open now, the order page, counts and limits. | read-only |
| `get_shop_settings` | Every setting of the shop, as the shop uses it. | read-only |
| `update_shop_settings` | Change settings of the shop. | destructive |
| `list_shop_categories` | The categories of the catalog. | read-only |
| `search_shop_items` | Search and filter the products. | read-only |
| `get_shop_item` | One product with variants, option groups and pictures. | read-only |
| `create_shop_item` | Add a product. | destructive |
| `update_shop_item` | Change a product: only the keys sent change. | destructive |
| `archive_shop_item` | Archive a product. | destructive |
| `set_shop_stock` | Set or change the stock of a product. | destructive |
| `set_shop_sold_out` | Mark a product sold out for a while, or back. | destructive |
| `list_shop_orders` | The orders, newest first. | read-only |
| `get_shop_order` | One order with lines, payment, next steps and history. | read-only |
| `update_shop_order` | Move an order on, change its time, cancel or decline it. | destructive |
| `refund_shop_order` | Refund an order that was paid online. | destructive |
| `quote_shop_order` | Price a cart: total, problems, times and ways to pay. | read-only |
| `create_shop_order` | Place an order for a customer. | destructive |
| `get_shop_report` | The shop's figures for a range of days. | read-only |
| `get_shop_order_link` | A customer's personal link to the order page. | read-only |
| `list_automations` | The automations. | read-only |
| `get_automation` | One automation. | read-only |
| `create_automation` | Create an automation: when, if, do. | destructive |
| `update_automation` | Change an automation, or switch it on or off. | destructive |
| `delete_automation` | Delete an automation. | destructive |
| `try_automation` | Try an automation on a real submission, saving and sending nothing. | destructive |
| `list_automation_runs` | The automation run log, step by step. | read-only |
| `run_submission_action` | Run a manual automation on a submission. | destructive |
| `list_connections` | The connections to outside systems. | read-only |
| `set_connection` | Create or change a connection (HTTP, OpenAPI or MCP). | destructive |
| `delete_connection` | Delete a connection. | destructive |
| `test_connection` | Test a connection: can app2email reach it and sign in?. | destructive |
| `refresh_connection` | Read a connection's operations or tools again. | destructive |
| `list_connection_functions` | What an action can call on a connection. | read-only |
| `get_submit_guide` | The Submit-Info guide for agents: every key, rule and example. | read-only |
| `get_submit_settings` | Submit-Info settings: the switch, the config and the public code. | read-only |
| `update_submit_settings` | Switch Submit-Info on or off and change its settings. | destructive |
| `apply_submit_setup` | Apply or dry-run a whole setup: forms, lists, automations. | destructive |
| `list_submit_presets` | The ready-made setups (presets), or one complete preset. | read-only |
| `list_forms` | The forms of the number. | read-only |
| `create_form` | Create a form from a definition or a preset. | destructive |
| `get_form` | One form: definition, fields, links and WhatsApp state. | read-only |
| `update_form` | Change a form: name, on or off, archive, definition. | destructive |
| `delete_form` | Delete a form (archived when it has submissions). | destructive |
| `publish_form` | Publish a form to WhatsApp. | destructive |
| `send_form` | Send a form to a contact, with values filled in. | destructive |
| `list_submit_lists` | The choice lists (sites, jobs, price lists). | read-only |
| `set_submit_list` | Create a list or replace its items. | destructive |
| `delete_submit_list` | Delete a list. | destructive |
| `list_submissions` | The submissions, filtered and paged (JSON or CSV). | read-only |
| `get_submission` | One submission with files, activity and what can be done. | read-only |
| `create_submission` | Create a submission from data you already hold. | destructive |
| `update_submission` | Change a submission: stage, assignee, tags, answers. | destructive |
| `add_submission_note` | Write an internal note on a submission. | destructive |
| `reply_to_submission` | Message the submitter, with up to 3 buttons. | destructive |
| `add_submission_file` | Attach a file to a submission. | destructive |
| `delete_submission` | Delete a submission, or erase it for good. | destructive |
| `list_submit_members` | The team: who works in the shared inbox. | read-only |
| `invite_submit_member` | Invite a person to the shared inbox by e-mail. | destructive |
| `update_submit_member` | Change a member's role, abilities or forms. | destructive |
| `remove_submit_member` | Remove a member from the inbox. | destructive |
| `get_submit_report` | Submission counts by form, stage, day and assignee. | read-only |
| `create_template` | Create a template and submit it for approval. | destructive |
| `edit_template` | Edit a template (components, category, TTL, max price). | destructive |
| `delete_template` | Delete a template (every language, or one). | destructive |
| `delete_templates` | Delete several templates at once (all or nothing). | destructive |
| `archive_template` | Archive a template (deleted by WhatsApp after 28 days). | destructive |
| `unarchive_template` | Unarchive a template. | destructive |
| `compare_templates` | Compare two templates: block rate, sends, top block reason. | read-only |
| `list_template_library` | Meta's Template Library (pre-approved templates). | read-only |
| `upsert_auth_template` | Create or update an authentication template in many languages. | destructive |
| `preview_auth_templates` | Authentication template texts, per language. | read-only |
| `get_template_insights` | Template insights: sent, delivered, read, clicked, cost. | read-only |
| `enable_template_insights` | Switch template insights on (cannot be undone). | destructive |
| `list_ticket_events` | The events, newest first. | read-only |
| `get_ticket_event` | One event with its dates and ticket types. | read-only |
| `get_ticket_availability` | What is on sale and how many are left for a date. | read-only |
| `list_ticket_orders` | The ticket orders, newest first. | read-only |
| `get_ticket_order` | One order with its tickets, by id or reference. | read-only |
| `create_ticket_order` | Issue complimentary tickets or record a sale paid outside. | destructive |
| `refund_ticket_order` | Refund an order or some of its tickets. | destructive |
| `resend_tickets` | Send the buyer their tickets again. | destructive |
| `list_tickets` | The tickets (attendees) with their check-in state. | read-only |
| `check_in_ticket` | Check a ticket in (or out) by its code or id. | destructive |
| `get_ticket_stats` | Sales and check-in figures of an event or one date. | read-only |
| `list_ticket_waitlist` | The waiting list of a sold-out date. | read-only |
| `list_webhooks` | Your webhooks. | read-only |
| `create_webhook` | Get events at your URL. | destructive |
| `update_webhook` | Change a webhook: url, active, headers, format. | destructive |
| `delete_webhook` | Delete a webhook. | destructive |
| `test_webhook_url` | Send a test event to any URL. | destructive |
| `create_webhook_catcher` | Get a temporary URL that keeps what it receives. | destructive |
| `get_webhook_catcher` | What a catcher received. | read-only |

## Links

- Management MCP (an agent creates the account): https://www.app2email.com/docs/api/agents.md
- API reference: https://www.app2email.com/docs/api · https://www.app2email.com/llms.txt · https://api.app2email.com/v1/openapi.json
