# app2email WhatsApp API > REST API (and MCP server) for WhatsApp messages from a business number connected to app2email. Base URL https://api.app2email.com/v1/{number}/ ; auth `Authorization: Bearer `; a sandbox key sends nothing. Every link is the Markdown twin of an HTML page (the same URL without `.md`). ## Start - [Overview](https://www.app2email.com/docs/api.md): base URL, auth, quick start, every call - [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) ## Messages - [Messages sent and received, newest first](https://www.app2email.com/docs/api/messages/list-messages.md): GET /v1/{number}/messages - [Send a WhatsApp message: template, or free-form reply](https://www.app2email.com/docs/api/messages/send-template-message.md): POST /v1/{number}/messages - [Status of a sent message](https://www.app2email.com/docs/api/messages/get-message-status.md): GET /v1/{number}/messages/{message_id} - [Mark a received message as read, optionally typing](https://www.app2email.com/docs/api/messages/mark-message-read.md): POST /v1/{number}/messages/read - [Where marketing templates go: Cloud API or Marketing Messages API](https://www.app2email.com/docs/api/messages/get-marketing-status.md): GET /v1/{number}/marketing ## Media - [Upload a file once, get a media id](https://www.app2email.com/docs/api/media/upload-media.md): POST /v1/{number}/media - [Download a received file (stored copy, else from WhatsApp)](https://www.app2email.com/docs/api/media/get-media.md): GET /v1/{number}/media/{id} - [Delete an uploaded file at WhatsApp](https://www.app2email.com/docs/api/media/delete-media.md): DELETE /v1/{number}/media/{id} ## Conversations - [The contacts, most recent activity first](https://www.app2email.com/docs/api/conversations/list-conversations.md): GET /v1/{number}/conversations - [One contact's messages, both directions](https://www.app2email.com/docs/api/conversations/list-conversation-messages.md): GET /v1/{number}/conversations/{phone}/messages - [One contact: window state, last messages, owner](https://www.app2email.com/docs/api/conversations/get-conversation.md): GET /v1/{number}/conversations/{contact} - [Hand a contact over: human, agent, paused, or back to normal](https://www.app2email.com/docs/api/conversations/set-conversation-owner.md): PUT /v1/{number}/conversations/{contact}/owner ## Templates - [List your templates, with an example request for each](https://www.app2email.com/docs/api/templates/list-templates.md): GET /v1/{number}/templates - [Create a template and submit it for approval](https://www.app2email.com/docs/api/templates/create-template.md): POST /v1/{number}/templates - [One template: status, rejection reason, what it needs](https://www.app2email.com/docs/api/templates/get-template.md): GET /v1/{number}/templates/{name} - [Edit a template (components, category, TTL, max price)](https://www.app2email.com/docs/api/templates/edit-template.md): PATCH /v1/{number}/templates/{name} - [Delete a template (every language, or one)](https://www.app2email.com/docs/api/templates/delete-template.md): DELETE /v1/{number}/templates/{name} - [Delete several templates at once (all or nothing)](https://www.app2email.com/docs/api/templates/delete-templates.md): POST /v1/{number}/templates/delete - [Archive a template (deleted by WhatsApp after 28 days)](https://www.app2email.com/docs/api/templates/archive-template.md): POST /v1/{number}/templates/{name}/archive - [Unarchive a template](https://www.app2email.com/docs/api/templates/unarchive-template.md): POST /v1/{number}/templates/{name}/unarchive - [Compare two templates: block rate, sends, top block reason](https://www.app2email.com/docs/api/templates/compare-templates.md): GET /v1/{number}/templates/{name}/compare - [Create or update an authentication template in many languages](https://www.app2email.com/docs/api/templates/upsert-auth-template.md): PUT /v1/{number}/templates/{name}/authentication - [Authentication template texts, per language](https://www.app2email.com/docs/api/templates/preview-auth-templates.md): GET /v1/{number}/template-previews - [Meta's Template Library (pre-approved templates)](https://www.app2email.com/docs/api/templates/list-template-library.md): GET /v1/{number}/template-library - [Template insights: sent, delivered, read, clicked, cost](https://www.app2email.com/docs/api/templates/get-template-insights.md): GET /v1/{number}/template-insights - [Switch template insights on (cannot be undone)](https://www.app2email.com/docs/api/templates/enable-template-insights.md): POST /v1/{number}/template-insights ## Flows - [List WhatsApp Flows](https://www.app2email.com/docs/api/flows/list-flows.md): GET /v1/{number}/flows - [Create a flow (draft, or published at once)](https://www.app2email.com/docs/api/flows/create-flow.md): POST /v1/{number}/flows - [One flow: status, validation errors, health](https://www.app2email.com/docs/api/flows/get-flow.md): GET /v1/{number}/flows/{id} - [Change a flow's name, categories or endpoint](https://www.app2email.com/docs/api/flows/update-flow.md): PATCH /v1/{number}/flows/{id} - [Delete a draft flow](https://www.app2email.com/docs/api/flows/delete-flow.md): DELETE /v1/{number}/flows/{id} - [A flow's Flow JSON](https://www.app2email.com/docs/api/flows/get-flow-json.md): GET /v1/{number}/flows/{id}/json - [Replace a flow's Flow JSON](https://www.app2email.com/docs/api/flows/update-flow-json.md): PUT /v1/{number}/flows/{id}/json - [Publish a flow (cannot be undone)](https://www.app2email.com/docs/api/flows/publish-flow.md): POST /v1/{number}/flows/{id}/publish - [Deprecate a published flow (cannot be undone)](https://www.app2email.com/docs/api/flows/deprecate-flow.md): POST /v1/{number}/flows/{id}/deprecate - [A public preview link of a flow (30 days)](https://www.app2email.com/docs/api/flows/get-flow-preview.md): GET /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): POST /v1/{number}/flows/{id}/preview - [The number's public key for flows with a data endpoint](https://www.app2email.com/docs/api/flows/get-flow-encryption-key.md): GET /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): PUT /v1/{number}/flows/encryption-key ## Book-and-Pay - [The waitlist of full days](https://www.app2email.com/docs/api/book-and-pay/list-booking-waitlist.md): GET /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): POST /v1/{number}/bookings/waitlist - [Take a customer off the waitlist](https://www.app2email.com/docs/api/book-and-pay/remove-from-booking-waitlist.md): POST /v1/{number}/bookings/waitlist/{reference}/remove - [The appointments, soonest start first](https://www.app2email.com/docs/api/book-and-pay/list-bookings.md): GET /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): POST /v1/{number}/bookings - [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): GET /v1/{number}/bookings/availability - [The booking report of a range of days](https://www.app2email.com/docs/api/book-and-pay/get-booking-reports.md): GET /v1/{number}/bookings/reports - [One appointment, by id or reference](https://www.app2email.com/docs/api/book-and-pay/get-booking.md): GET /v1/{number}/bookings/{id} - [Cancel an appointment](https://www.app2email.com/docs/api/book-and-pay/cancel-booking.md): POST /v1/{number}/bookings/{id}/cancel - [Mark an appointment completed, a no-show, or back to confirmed](https://www.app2email.com/docs/api/book-and-pay/set-booking-status.md): POST /v1/{number}/bookings/{id}/status - [The booking settings, the default Flow's status and every Flow](https://www.app2email.com/docs/api/book-and-pay/get-booking-settings.md): GET /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): PUT /v1/{number}/settings/booking - [Send a Flow to a contact (the booking form or another form)](https://www.app2email.com/docs/api/book-and-pay/send-flow.md): POST /v1/{number}/flows/{key}/send ## Tickets-and-Pay - [The events, newest first](https://www.app2email.com/docs/api/tickets-and-pay/list-ticket-events.md): GET /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): POST /v1/{number}/tickets/events - [One event with its dates and ticket types](https://www.app2email.com/docs/api/tickets-and-pay/get-ticket-event.md): GET /v1/{number}/tickets/events/{id} - [Change an event](https://www.app2email.com/docs/api/tickets-and-pay/update-ticket-event.md): PATCH /v1/{number}/tickets/events/{id} - [Publish an event so tickets can be bought](https://www.app2email.com/docs/api/tickets-and-pay/publish-ticket-event.md): POST /v1/{number}/tickets/events/{id}/publish - [Cancel an event and refund or void its tickets](https://www.app2email.com/docs/api/tickets-and-pay/cancel-ticket-event.md): POST /v1/{number}/tickets/events/{id}/cancel - [The dates of an event with what is sold and left](https://www.app2email.com/docs/api/tickets-and-pay/list-ticket-dates.md): GET /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): POST /v1/{number}/tickets/events/{id}/dates - [Change a date: time, label, capacity, sales on or paused](https://www.app2email.com/docs/api/tickets-and-pay/update-ticket-date.md): PATCH /v1/{number}/tickets/dates/{date_id} - [Cancel one date and refund or void its tickets](https://www.app2email.com/docs/api/tickets-and-pay/cancel-ticket-date.md): POST /v1/{number}/tickets/dates/{date_id}/cancel - [The door list of a date for your own scanner](https://www.app2email.com/docs/api/tickets-and-pay/get-ticket-door-list.md): GET /v1/{number}/tickets/dates/{date_id}/door - [The ticket types and extras of an event](https://www.app2email.com/docs/api/tickets-and-pay/list-ticket-types.md): GET /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): POST /v1/{number}/tickets/events/{id}/types - [Change or archive a ticket type](https://www.app2email.com/docs/api/tickets-and-pay/update-ticket-type.md): PATCH /v1/{number}/tickets/types/{type_id} - [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): GET /v1/{number}/tickets/events/{id}/availability - [The ticket orders, newest first](https://www.app2email.com/docs/api/tickets-and-pay/list-ticket-orders.md): GET /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): POST /v1/{number}/tickets/orders - [One order with its tickets, by id or reference](https://www.app2email.com/docs/api/tickets-and-pay/get-ticket-order.md): GET /v1/{number}/tickets/orders/{id} - [Refund an order or some of its tickets](https://www.app2email.com/docs/api/tickets-and-pay/refund-ticket-order.md): POST /v1/{number}/tickets/orders/{id}/refund - [Send the buyer their tickets again](https://www.app2email.com/docs/api/tickets-and-pay/resend-ticket-order.md): POST /v1/{number}/tickets/orders/{id}/resend - [The tickets (attendees) with their check-in state](https://www.app2email.com/docs/api/tickets-and-pay/list-tickets.md): GET /v1/{number}/tickets/issued - [One ticket](https://www.app2email.com/docs/api/tickets-and-pay/get-ticket.md): GET /v1/{number}/tickets/issued/{id} - [Void one ticket without a refund](https://www.app2email.com/docs/api/tickets-and-pay/void-ticket.md): POST /v1/{number}/tickets/issued/{id}/void - [Check a ticket in (or out) by its code or id](https://www.app2email.com/docs/api/tickets-and-pay/check-in-ticket.md): POST /v1/{number}/tickets/check-ins - [Take a check-in back](https://www.app2email.com/docs/api/tickets-and-pay/undo-ticket-check-in.md): POST /v1/{number}/tickets/check-ins/{scan_id}/undo - [The promo and access codes with their uses](https://www.app2email.com/docs/api/tickets-and-pay/list-ticket-codes.md): GET /v1/{number}/tickets/codes - [Create a promo or access code](https://www.app2email.com/docs/api/tickets-and-pay/create-ticket-code.md): POST /v1/{number}/tickets/codes - [Change a promo code or switch it off](https://www.app2email.com/docs/api/tickets-and-pay/update-ticket-code.md): PATCH /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): DELETE /v1/{number}/tickets/codes/{id} - [The waiting list of a sold-out date](https://www.app2email.com/docs/api/tickets-and-pay/list-ticket-waitlist.md): GET /v1/{number}/tickets/waitlist - [Sales and check-in figures of an event or one date](https://www.app2email.com/docs/api/tickets-and-pay/get-ticket-stats.md): GET /v1/{number}/tickets/stats - [The ticket settings and whether ticket sales are switched on](https://www.app2email.com/docs/api/tickets-and-pay/get-ticket-settings.md): GET /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): PUT /v1/{number}/settings/tickets ## Submit-Info - [The Submit-Info guide for agents: every key, rule and example](https://www.app2email.com/docs/api/submit-info/get-submit-guide.md): GET /v1/{number}/submit/guide - [Submit-Info settings: the switch, the config and the public code](https://www.app2email.com/docs/api/submit-info/get-submit-settings.md): GET /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): PUT /v1/{number}/submit/settings - [Apply or dry-run a whole setup: forms, lists, automations](https://www.app2email.com/docs/api/submit-info/apply-submit-setup.md): POST /v1/{number}/submit/setup - [The ready-made setups (presets), or one complete preset](https://www.app2email.com/docs/api/submit-info/list-submit-presets.md): GET /v1/{number}/submit/presets - [The forms of the number](https://www.app2email.com/docs/api/submit-info/list-forms.md): GET /v1/{number}/submit/forms - [Create a form from a definition or a preset](https://www.app2email.com/docs/api/submit-info/create-form.md): POST /v1/{number}/submit/forms - [One form: definition, fields, links and WhatsApp state](https://www.app2email.com/docs/api/submit-info/get-form.md): GET /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): PUT /v1/{number}/submit/forms/{key} - [Delete a form (archived when it has submissions)](https://www.app2email.com/docs/api/submit-info/delete-form.md): DELETE /v1/{number}/submit/forms/{key} - [Publish a form to WhatsApp](https://www.app2email.com/docs/api/submit-info/publish-form.md): POST /v1/{number}/submit/forms/{key}/publish - [Send a form to a contact, with values filled in](https://www.app2email.com/docs/api/submit-info/send-form.md): POST /v1/{number}/submit/forms/{key}/send - [The choice lists (sites, jobs, price lists)](https://www.app2email.com/docs/api/submit-info/list-submit-lists.md): GET /v1/{number}/submit/lists - [Create a list or replace its items](https://www.app2email.com/docs/api/submit-info/set-submit-list.md): PUT /v1/{number}/submit/lists/{key} - [Delete a list](https://www.app2email.com/docs/api/submit-info/delete-submit-list.md): DELETE /v1/{number}/submit/lists/{key} - [The submissions, filtered and paged (JSON or CSV)](https://www.app2email.com/docs/api/submit-info/list-submissions.md): GET /v1/{number}/submit/submissions - [Create a submission from data you already hold](https://www.app2email.com/docs/api/submit-info/create-submission.md): POST /v1/{number}/submit/submissions - [One submission with files, activity and what can be done](https://www.app2email.com/docs/api/submit-info/get-submission.md): GET /v1/{number}/submit/submissions/{id} - [Change a submission: stage, assignee, tags, answers](https://www.app2email.com/docs/api/submit-info/update-submission.md): PATCH /v1/{number}/submit/submissions/{id} - [Delete a submission, or erase it for good](https://www.app2email.com/docs/api/submit-info/delete-submission.md): DELETE /v1/{number}/submit/submissions/{id} - [Write an internal note on a submission](https://www.app2email.com/docs/api/submit-info/add-submission-note.md): POST /v1/{number}/submit/submissions/{id}/notes - [Message the submitter, with up to 3 buttons](https://www.app2email.com/docs/api/submit-info/reply-to-submission.md): POST /v1/{number}/submit/submissions/{id}/reply - [Attach a file to a submission](https://www.app2email.com/docs/api/submit-info/add-submission-file.md): POST /v1/{number}/submit/submissions/{id}/files - [Run a manual automation on a submission](https://www.app2email.com/docs/api/submit-info/run-submission-action.md): POST /v1/{number}/submit/submissions/{id}/run - [The team: who works in the shared inbox](https://www.app2email.com/docs/api/submit-info/list-submit-members.md): GET /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): POST /v1/{number}/submit/members - [Change a member's role, abilities or forms](https://www.app2email.com/docs/api/submit-info/update-submit-member.md): PUT /v1/{number}/submit/members/{id} - [Remove a member from the inbox](https://www.app2email.com/docs/api/submit-info/remove-submit-member.md): DELETE /v1/{number}/submit/members/{id} - [The automations](https://www.app2email.com/docs/api/submit-info/list-automations.md): GET /v1/{number}/submit/automations - [Create an automation: when, if, do](https://www.app2email.com/docs/api/submit-info/create-automation.md): POST /v1/{number}/submit/automations - [Try an automation on a real submission, saving and sending nothing](https://www.app2email.com/docs/api/submit-info/try-automation.md): POST /v1/{number}/submit/automations/try - [One automation](https://www.app2email.com/docs/api/submit-info/get-automation.md): GET /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): PUT /v1/{number}/submit/automations/{id} - [Delete an automation](https://www.app2email.com/docs/api/submit-info/delete-automation.md): DELETE /v1/{number}/submit/automations/{id} - [The automation run log, step by step](https://www.app2email.com/docs/api/submit-info/list-automation-runs.md): GET /v1/{number}/submit/runs - [The connections to outside systems](https://www.app2email.com/docs/api/submit-info/list-connections.md): GET /v1/{number}/submit/connections - [Create or change a connection (HTTP, OpenAPI or MCP)](https://www.app2email.com/docs/api/submit-info/set-connection.md): PUT /v1/{number}/submit/connections/{key} - [Delete a connection](https://www.app2email.com/docs/api/submit-info/delete-connection.md): DELETE /v1/{number}/submit/connections/{key} - [Test a connection: can app2email reach it and sign in?](https://www.app2email.com/docs/api/submit-info/test-connection.md): POST /v1/{number}/submit/connections/{key}/test - [Read a connection's operations or tools again](https://www.app2email.com/docs/api/submit-info/refresh-connection.md): POST /v1/{number}/submit/connections/{key}/refresh - [What an action can call on a connection](https://www.app2email.com/docs/api/submit-info/list-connection-functions.md): GET /v1/{number}/submit/connections/{key}/functions - [Submission counts by form, stage, day and assignee](https://www.app2email.com/docs/api/submit-info/get-submit-report.md): GET /v1/{number}/submit/report ## Order-and-Pay - [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): GET /v1/{number}/shop - [Every setting of the shop, as the shop uses it](https://www.app2email.com/docs/api/order-and-pay/get-shop-settings.md): GET /v1/{number}/shop/settings - [Change settings of the shop](https://www.app2email.com/docs/api/order-and-pay/update-shop-settings.md): PUT /v1/{number}/shop/settings - [The categories of the catalog](https://www.app2email.com/docs/api/order-and-pay/list-shop-categories.md): GET /v1/{number}/shop/categories - [Search and filter the products](https://www.app2email.com/docs/api/order-and-pay/list-shop-items.md): GET /v1/{number}/shop/items - [Add a product](https://www.app2email.com/docs/api/order-and-pay/create-shop-item.md): POST /v1/{number}/shop/items - [One product with variants, option groups and pictures](https://www.app2email.com/docs/api/order-and-pay/get-shop-item.md): GET /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): PUT /v1/{number}/shop/items/{id} - [Archive a product](https://www.app2email.com/docs/api/order-and-pay/archive-shop-item.md): DELETE /v1/{number}/shop/items/{id} - [Set or change the stock of a product](https://www.app2email.com/docs/api/order-and-pay/set-shop-stock.md): POST /v1/{number}/shop/items/{id}/stock - [Mark a product sold out for a while, or back](https://www.app2email.com/docs/api/order-and-pay/set-shop-sold-out.md): POST /v1/{number}/shop/items/{id}/sold_out - [The orders, newest first](https://www.app2email.com/docs/api/order-and-pay/list-shop-orders.md): GET /v1/{number}/shop/orders - [Place an order for a customer](https://www.app2email.com/docs/api/order-and-pay/create-shop-order.md): POST /v1/{number}/shop/orders - [One order with lines, payment, next steps and history](https://www.app2email.com/docs/api/order-and-pay/get-shop-order.md): GET /v1/{number}/shop/orders/{id} - [Move an order on, change its time, cancel or decline it](https://www.app2email.com/docs/api/order-and-pay/update-shop-order.md): POST /v1/{number}/shop/orders/{id}/action - [Refund an order that was paid online](https://www.app2email.com/docs/api/order-and-pay/refund-shop-order.md): POST /v1/{number}/shop/orders/{id}/refund - [Price a cart: total, problems, times and ways to pay](https://www.app2email.com/docs/api/order-and-pay/quote-shop-order.md): POST /v1/{number}/shop/quote - [The shop's figures for a range of days](https://www.app2email.com/docs/api/order-and-pay/get-shop-report.md): GET /v1/{number}/shop/report - [A customer's personal link to the order page](https://www.app2email.com/docs/api/order-and-pay/get-shop-order-link.md): POST /v1/{number}/shop/link ## Broadcasts - [Your latest broadcasts](https://www.app2email.com/docs/api/broadcasts/list-broadcasts.md): GET /v1/{number}/broadcasts - [A broadcast's status and the result per number](https://www.app2email.com/docs/api/broadcasts/get-broadcast.md): GET /v1/{number}/broadcasts/{code} - [A broadcast's result for each message, as CSV](https://www.app2email.com/docs/api/broadcasts/get-broadcast-csv.md): GET /v1/{number}/broadcasts/{code}/results.csv - [Cancel a scheduled or sending API broadcast](https://www.app2email.com/docs/api/broadcasts/cancel-broadcast.md): POST /v1/{number}/broadcasts/{code}/cancel ## Contacts - [Your contacts, newest first](https://www.app2email.com/docs/api/contacts/list-contacts.md): GET /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): POST /v1/{number}/contacts - [Import contacts from CSV or JSON (up to 5000 rows)](https://www.app2email.com/docs/api/contacts/import-contacts.md): POST /v1/{number}/contacts/import - [All contacts as CSV](https://www.app2email.com/docs/api/contacts/export-contacts.md): GET /v1/{number}/contacts/export.csv - [One contact](https://www.app2email.com/docs/api/contacts/get-contact.md): GET /v1/{number}/contacts/{identity} - [Change a contact](https://www.app2email.com/docs/api/contacts/update-contact.md): PATCH /v1/{number}/contacts/{identity} - [Delete a contact record](https://www.app2email.com/docs/api/contacts/delete-contact.md): DELETE /v1/{number}/contacts/{identity} - [Record consent (or its withdrawal) with evidence](https://www.app2email.com/docs/api/contacts/record-consent.md): POST /v1/{number}/contacts/{identity}/consent - [Your segments (saved contact filters)](https://www.app2email.com/docs/api/contacts/list-segments.md): GET /v1/{number}/segments - [Save a contact filter as a segment](https://www.app2email.com/docs/api/contacts/create-segment.md): POST /v1/{number}/segments - [One segment, with how many contacts match now](https://www.app2email.com/docs/api/contacts/get-segment.md): GET /v1/{number}/segments/{id} - [Rename a segment or replace its filter](https://www.app2email.com/docs/api/contacts/update-segment.md): PUT /v1/{number}/segments/{id} - [Delete a segment (its contacts stay)](https://www.app2email.com/docs/api/contacts/delete-segment.md): DELETE /v1/{number}/segments/{id} - [The contacts a segment matches now](https://www.app2email.com/docs/api/contacts/list-segment-contacts.md): GET /v1/{number}/segments/{id}/contacts - [WhatsApp users this number blocked](https://www.app2email.com/docs/api/contacts/list-blocked-users.md): GET /v1/{number}/blocked - [Block WhatsApp users](https://www.app2email.com/docs/api/contacts/block-users.md): POST /v1/{number}/blocked - [Unblock WhatsApp users](https://www.app2email.com/docs/api/contacts/unblock-users.md): DELETE /v1/{number}/blocked - [Is a phone number on file for a business-scoped user id](https://www.app2email.com/docs/api/contacts/get-contact-book-entry.md): GET /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): DELETE /v1/{number}/contact-book/{bsuid} ## Opt-ins - [Is the opt-in rule for marketing on?](https://www.app2email.com/docs/api/opt-ins/get-optin-setting.md): GET /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): PUT /v1/{number}/settings/optin - [The opt-in records, or check one number](https://www.app2email.com/docs/api/opt-ins/list-optins.md): GET /v1/{number}/optins - [Record that people opted in](https://www.app2email.com/docs/api/opt-ins/add-optins.md): POST /v1/{number}/optins - [Remove an opt-in record](https://www.app2email.com/docs/api/opt-ins/remove-optin.md): DELETE /v1/{number}/optins/{phone} ## Do Not Call - [The Do Not Call list, or check one number](https://www.app2email.com/docs/api/do-not-call/list-do-not-call.md): GET /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): POST /v1/{number}/donotcall - [Remove a number from the Do Not Call list](https://www.app2email.com/docs/api/do-not-call/remove-do-not-call.md): DELETE /v1/{number}/donotcall/{phone} - [Consent records, Do Not Call list and opt-ins as one CSV](https://www.app2email.com/docs/api/do-not-call/export-compliance.md): GET /v1/{number}/compliance/export.csv ## Approvals - [Sends held for approval](https://www.app2email.com/docs/api/approvals/list-approvals.md): GET /v1/{number}/approvals - [Approve a held send: it is sent now](https://www.app2email.com/docs/api/approvals/approve-send.md): POST /v1/{number}/approvals/{id}/approve - [Reject a held send: nothing is sent](https://www.app2email.com/docs/api/approvals/reject-send.md): POST /v1/{number}/approvals/{id}/reject ## Number - [Number health: can it send, quality, limit, name status](https://www.app2email.com/docs/api/number/get-number-health.md): GET /v1/{number}/health - [Turn WhatsApp's identity change check on or off](https://www.app2email.com/docs/api/number/set-identity-check.md): PUT /v1/{number}/settings/identity-check - [The WhatsApp business profile](https://www.app2email.com/docs/api/number/get-business-profile.md): GET /v1/{number}/profile - [Change the WhatsApp business profile](https://www.app2email.com/docs/api/number/update-business-profile.md): PATCH /v1/{number}/profile - [Change the profile photo from a public link](https://www.app2email.com/docs/api/number/set-profile-photo.md): PUT /v1/{number}/profile/photo - [Submit a new display name for Meta's review](https://www.app2email.com/docs/api/number/set-display-name.md): PUT /v1/{number}/profile/display-name - [Official Business Account (blue tick) status](https://www.app2email.com/docs/api/number/get-official-business-account.md): GET /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): POST /v1/{number}/profile/official-business-account - [India business compliance information](https://www.app2email.com/docs/api/number/get-india-compliance.md): GET /v1/{number}/profile/india-compliance - [Set the India business compliance information](https://www.app2email.com/docs/api/number/set-india-compliance.md): PUT /v1/{number}/profile/india-compliance - [The business username](https://www.app2email.com/docs/api/number/get-username.md): GET /v1/{number}/username - [Adopt or change the business username](https://www.app2email.com/docs/api/number/set-username.md): PUT /v1/{number}/username - [Remove the business username](https://www.app2email.com/docs/api/number/delete-username.md): DELETE /v1/{number}/username - [Usernames reserved for the business](https://www.app2email.com/docs/api/number/get-username-suggestions.md): GET /v1/{number}/username/suggestions - [Ice breakers, commands and welcome message](https://www.app2email.com/docs/api/number/get-conversation-starters.md): GET /v1/{number}/settings/conversation-starters - [Set ice breakers, commands or the welcome message](https://www.app2email.com/docs/api/number/set-conversation-starters.md): PUT /v1/{number}/settings/conversation-starters - [QR codes and short links](https://www.app2email.com/docs/api/number/list-qr-codes.md): GET /v1/{number}/qr-codes - [Create a QR code and wa.me short link](https://www.app2email.com/docs/api/number/create-qr-code.md): POST /v1/{number}/qr-codes - [One QR code](https://www.app2email.com/docs/api/number/get-qr-code.md): GET /v1/{number}/qr-codes/{code} - [Change a QR code's prefilled message](https://www.app2email.com/docs/api/number/update-qr-code.md): PATCH /v1/{number}/qr-codes/{code} - [Delete a QR code and its short link](https://www.app2email.com/docs/api/number/delete-qr-code.md): DELETE /v1/{number}/qr-codes/{code} - [Cart and catalog icon on or off](https://www.app2email.com/docs/api/number/get-commerce-settings.md): GET /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): PUT /v1/{number}/settings/commerce - [The connected product catalog](https://www.app2email.com/docs/api/number/get-catalog.md): GET /v1/{number}/catalog - [Connect a product catalog](https://www.app2email.com/docs/api/number/connect-catalog.md): PUT /v1/{number}/catalog ## Settings - [The auto reply to new contacts](https://www.app2email.com/docs/api/settings/get-autoreply.md): GET /v1/{number}/settings/autoreply - [Change the auto reply text](https://www.app2email.com/docs/api/settings/set-autoreply.md): PUT /v1/{number}/settings/autoreply - [Who gets the messages by email](https://www.app2email.com/docs/api/settings/get-forwarding.md): GET /v1/{number}/settings/forwarding - [Change who gets the messages by email](https://www.app2email.com/docs/api/settings/set-forwarding.md): PUT /v1/{number}/settings/forwarding - [The number's settings: email behaviour, caps, compliance](https://www.app2email.com/docs/api/settings/get-number-settings.md): GET /v1/{number}/settings/number - [Change some of the number's settings](https://www.app2email.com/docs/api/settings/update-number-settings.md): PUT /v1/{number}/settings/number ## Webhooks - [Your webhooks](https://www.app2email.com/docs/api/webhooks/list-webhooks.md): GET /v1/{number}/webhooks - [Get events at your URL](https://www.app2email.com/docs/api/webhooks/create-webhook.md): POST /v1/{number}/webhooks - [A sample of every event](https://www.app2email.com/docs/api/webhooks/webhook-samples.md): GET /v1/{number}/webhooks/samples - [Change a webhook: url, active, headers, format](https://www.app2email.com/docs/api/webhooks/update-webhook.md): PATCH /v1/{number}/webhooks/{id} - [Delete a webhook](https://www.app2email.com/docs/api/webhooks/delete-webhook.md): DELETE /v1/{number}/webhooks/{id} - [Send a test event now](https://www.app2email.com/docs/api/webhooks/test-webhook.md): POST /v1/{number}/webhooks/{id}/test - [Make a new signing secret](https://www.app2email.com/docs/api/webhooks/rotate-webhook-secret.md): POST /v1/{number}/webhooks/{id}/rotate-secret - [The last deliveries, with every attempt](https://www.app2email.com/docs/api/webhooks/list-webhook-deliveries.md): GET /v1/{number}/webhooks/{id}/deliveries - [One delivery, with the event as it was sent](https://www.app2email.com/docs/api/webhooks/get-webhook-delivery.md): GET /v1/{number}/webhooks/{id}/deliveries/{event_id} - [Send a stored event again](https://www.app2email.com/docs/api/webhooks/redeliver-webhook-event.md): POST /v1/{number}/webhooks/{id}/deliveries/{event_id}/redeliver - [Fetch events (no webhook address needed)](https://www.app2email.com/docs/api/webhooks/list-events.md): GET /v1/{number}/events - [Send a test event to any URL](https://www.app2email.com/docs/api/webhooks/test-webhook-url.md): POST /v1/{number}/webhooks/test-url - [Your catchers](https://www.app2email.com/docs/api/webhooks/list-webhook-catchers.md): GET /v1/{number}/webhooks/catchers - [Get a temporary URL that keeps what it receives](https://www.app2email.com/docs/api/webhooks/create-webhook-catcher.md): POST /v1/{number}/webhooks/catchers - [What a catcher received](https://www.app2email.com/docs/api/webhooks/get-webhook-catcher.md): GET /v1/{number}/webhooks/catchers/{token} - [Delete a catcher](https://www.app2email.com/docs/api/webhooks/delete-webhook-catcher.md): DELETE /v1/{number}/webhooks/catchers/{token} ## Analytics - [WhatsApp cost and volume of this number](https://www.app2email.com/docs/api/analytics/get-pricing-analytics.md): GET /v1/{number}/analytics/pricing - [Messages sent and delivered, as WhatsApp counts them](https://www.app2email.com/docs/api/analytics/get-message-analytics.md): GET /v1/{number}/analytics/messages - [The WhatsApp Business Account's activity log](https://www.app2email.com/docs/api/analytics/get-account-activity.md): GET /v1/{number}/activity - [The Conversions API dataset of the account](https://www.app2email.com/docs/api/analytics/get-conversions-dataset.md): GET /v1/{number}/conversions/dataset - [Create the Conversions API dataset](https://www.app2email.com/docs/api/analytics/create-conversions-dataset.md): POST /v1/{number}/conversions/dataset - [Quality of the Conversions API dataset](https://www.app2email.com/docs/api/analytics/get-conversions-dataset-quality.md): GET /v1/{number}/conversions/dataset/quality - [Send conversion events of WhatsApp chats](https://www.app2email.com/docs/api/analytics/send-conversion-events.md): POST /v1/{number}/conversions/events ## Calling - [WhatsApp calling settings](https://www.app2email.com/docs/api/calling/get-call-settings.md): GET /v1/{number}/calling/settings - [Change the calling settings](https://www.app2email.com/docs/api/calling/update-call-settings.md): PATCH /v1/{number}/calling/settings - [Start, answer, reject or end a WhatsApp call](https://www.app2email.com/docs/api/calling/manage-call.md): POST /v1/{number}/calls - [May the number call this contact](https://www.app2email.com/docs/api/calling/get-call-permission.md): GET /v1/{number}/calls/permissions/{contact} ## Account - [Check the key: its scopes, the number, the plan and the limits](https://www.app2email.com/docs/api/account/get-me.md): GET /v1/{number}/me - [The latest logged API requests](https://www.app2email.com/docs/api/account/list-requests.md): GET /v1/{number}/requests - [One logged request, by its request_id](https://www.app2email.com/docs/api/account/get-request.md): GET /v1/{number}/requests/{id} - [Messages and broadcasts per month](https://www.app2email.com/docs/api/account/get-usage-history.md): GET /v1/{number}/usage/history - [Message counts, delivery and read rates for a period](https://www.app2email.com/docs/api/account/get-stats.md): GET /v1/{number}/stats - [Plan, messages used and left, limits, what WhatsApp charges](https://www.app2email.com/docs/api/account/get-usage.md): GET /v1/{number}/usage - [What WhatsApp charges this billing month, per day](https://www.app2email.com/docs/api/account/get-usage-meta.md): GET /v1/{number}/usage/meta ## Account management - [Instant sandbox: try the API with no account](https://www.app2email.com/docs/api/account-management/create-sandbox.md): POST /v1/account/sandbox - [Start an account for a person (agent sign-up)](https://www.app2email.com/docs/api/account-management/create-account.md): POST /v1/account/signup - [Account status and what is still needed](https://www.app2email.com/docs/api/account-management/get-account.md): GET /v1/account - [Plans that can be bought](https://www.app2email.com/docs/api/account-management/list-account-plans.md): GET /v1/account/plans - [Cost estimate for a number of messages a month](https://www.app2email.com/docs/api/account-management/estimate-cost.md): GET /v1/account/estimate - [The account's WhatsApp numbers](https://www.app2email.com/docs/api/account-management/list-account-numbers.md): GET /v1/account/numbers - [One number of the account](https://www.app2email.com/docs/api/account-management/get-account-number.md): GET /v1/account/numbers/{number} - [The keys of a number](https://www.app2email.com/docs/api/account-management/list-number-keys.md): GET /v1/account/numbers/{number}/keys - [Create a key for a number](https://www.app2email.com/docs/api/account-management/create-number-key.md): POST /v1/account/numbers/{number}/keys - [Revoke a key of a number](https://www.app2email.com/docs/api/account-management/revoke-number-key.md): DELETE /v1/account/numbers/{number}/keys/{key_id} - [Payment link for a plan of a number](https://www.app2email.com/docs/api/account-management/create-number-checkout.md): POST /v1/account/numbers/{number}/checkout - [Messages used this billing month, per number](https://www.app2email.com/docs/api/account-management/get-account-usage.md): GET /v1/account/usage - [Account keys](https://www.app2email.com/docs/api/account-management/list-account-keys.md): GET /v1/account/keys - [Create an account key](https://www.app2email.com/docs/api/account-management/create-account-key.md): POST /v1/account/keys - [Revoke an account key](https://www.app2email.com/docs/api/account-management/revoke-account-key.md): DELETE /v1/account/keys/{key_id} - [Account webhooks](https://www.app2email.com/docs/api/account-management/list-account-webhooks.md): GET /v1/account/webhooks - [Add an account webhook](https://www.app2email.com/docs/api/account-management/create-account-webhook.md): POST /v1/account/webhooks - [Change an account webhook](https://www.app2email.com/docs/api/account-management/update-account-webhook.md): PATCH /v1/account/webhooks/{id} - [Delete an account webhook](https://www.app2email.com/docs/api/account-management/delete-account-webhook.md): DELETE /v1/account/webhooks/{id} - [Send a test event to an account webhook](https://www.app2email.com/docs/api/account-management/test-account-webhook.md): POST /v1/account/webhooks/{id}/test - [New signing secret for an account webhook](https://www.app2email.com/docs/api/account-management/rotate-account-webhook-secret.md): POST /v1/account/webhooks/{id}/rotate-secret - [Deliveries of an account webhook](https://www.app2email.com/docs/api/account-management/list-account-webhook-deliveries.md): GET /v1/account/webhooks/{id}/deliveries - [One delivery of an account webhook](https://www.app2email.com/docs/api/account-management/get-account-webhook-delivery.md): GET /v1/account/webhooks/{id}/deliveries/{event_id} - [Send a stored event again to an account webhook](https://www.app2email.com/docs/api/account-management/redeliver-account-webhook-event.md): POST /v1/account/webhooks/{id}/deliveries/{event_id}/redeliver ## Partner - [The partner account](https://www.app2email.com/docs/api/partner/get-partner.md): GET /v1/partner - [Change the partner settings](https://www.app2email.com/docs/api/partner/update-partner.md): PATCH /v1/partner - [Clients](https://www.app2email.com/docs/api/partner/list-partner-clients.md): GET /v1/partner/clients - [Create a client](https://www.app2email.com/docs/api/partner/create-partner-client.md): POST /v1/partner/clients - [One client](https://www.app2email.com/docs/api/partner/get-partner-client.md): GET /v1/partner/clients/{client_id} - [Change a client](https://www.app2email.com/docs/api/partner/update-partner-client.md): PATCH /v1/partner/clients/{client_id} - [Usage of a client](https://www.app2email.com/docs/api/partner/get-partner-client-usage.md): GET /v1/partner/clients/{client_id}/usage - [Numbers of your clients](https://www.app2email.com/docs/api/partner/list-partner-numbers.md): GET /v1/partner/numbers - [One number](https://www.app2email.com/docs/api/partner/get-partner-number.md): GET /v1/partner/numbers/{number} - [Usage of a number](https://www.app2email.com/docs/api/partner/get-partner-number-usage.md): GET /v1/partner/numbers/{number}/usage - [Keys of a number](https://www.app2email.com/docs/api/partner/list-partner-number-keys.md): GET /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): POST /v1/partner/numbers/{number}/keys - [Revoke a key of a client's number](https://www.app2email.com/docs/api/partner/revoke-partner-number-key.md): DELETE /v1/partner/numbers/{number}/keys/{key_id} - [Onboarding link for a new or existing client](https://www.app2email.com/docs/api/partner/create-onboarding-link.md): POST /v1/partner/onboarding-links - [Client payments](https://www.app2email.com/docs/api/partner/list-partner-payments.md): GET /v1/partner/payments - [Client plans](https://www.app2email.com/docs/api/partner/list-partner-subscriptions.md): GET /v1/partner/subscriptions - [Partner webhooks](https://www.app2email.com/docs/api/partner/list-partner-webhooks.md): GET /v1/partner/webhooks - [Add a partner webhook](https://www.app2email.com/docs/api/partner/create-partner-webhook.md): POST /v1/partner/webhooks - [Change a partner webhook](https://www.app2email.com/docs/api/partner/update-partner-webhook.md): PATCH /v1/partner/webhooks/{id} - [Delete a partner webhook](https://www.app2email.com/docs/api/partner/delete-partner-webhook.md): DELETE /v1/partner/webhooks/{id} - [Send a test event to a partner webhook](https://www.app2email.com/docs/api/partner/test-partner-webhook.md): POST /v1/partner/webhooks/{id}/test - [New signing secret for a partner webhook](https://www.app2email.com/docs/api/partner/rotate-partner-webhook-secret.md): POST /v1/partner/webhooks/{id}/rotate-secret - [Deliveries of a partner webhook](https://www.app2email.com/docs/api/partner/list-partner-webhook-deliveries.md): GET /v1/partner/webhooks/{id}/deliveries - [One delivery of a partner webhook](https://www.app2email.com/docs/api/partner/get-partner-webhook-delivery.md): GET /v1/partner/webhooks/{id}/deliveries/{event_id} - [Send a stored event again to a partner webhook](https://www.app2email.com/docs/api/partner/redeliver-partner-webhook-event.md): POST /v1/partner/webhooks/{id}/deliveries/{event_id}/redeliver ## Calendar - [Change an appointment's details](https://www.app2email.com/docs/api/calendar/update-booking.md): PATCH /v1/{number}/bookings/{id} - [Everything on the calendar for a range of days](https://www.app2email.com/docs/api/calendar/get-calendar.md): GET /v1/{number}/calendar - [The blocked times](https://www.app2email.com/docs/api/calendar/list-calendar-blocks.md): GET /v1/{number}/calendar/blocks - [Block time so that no one can book it](https://www.app2email.com/docs/api/calendar/create-calendar-block.md): POST /v1/{number}/calendar/blocks - [Change a blocked time](https://www.app2email.com/docs/api/calendar/update-calendar-block.md): PATCH /v1/{number}/calendar/blocks/{id} - [Remove a blocked time](https://www.app2email.com/docs/api/calendar/delete-calendar-block.md): DELETE /v1/{number}/calendar/blocks/{id} - [The services a customer can book, and their staff](https://www.app2email.com/docs/api/calendar/list-bookable-services.md): GET /v1/{number}/bookings/services - [The staff members and the services they do](https://www.app2email.com/docs/api/calendar/list-booking-staff.md): GET /v1/{number}/bookings/staff - [The next free start times for a service, across days](https://www.app2email.com/docs/api/calendar/get-next-booking-slots.md): GET /v1/{number}/bookings/next - [Move an appointment to another time](https://www.app2email.com/docs/api/calendar/reschedule-booking.md): POST /v1/{number}/bookings/{id}/reschedule - [The internal notes of an appointment and its customer](https://www.app2email.com/docs/api/calendar/list-booking-notes.md): GET /v1/{number}/bookings/{id}/notes - [Add an internal note to an appointment](https://www.app2email.com/docs/api/calendar/add-booking-note.md): POST /v1/{number}/bookings/{id}/notes - [The internal notes of a customer](https://www.app2email.com/docs/api/calendar/list-customer-notes.md): GET /v1/{number}/bookings/notes - [Add an internal note to a customer](https://www.app2email.com/docs/api/calendar/add-customer-note.md): POST /v1/{number}/bookings/notes - [Delete an internal note](https://www.app2email.com/docs/api/calendar/delete-booking-note.md): DELETE /v1/{number}/bookings/notes/{note_id} - [The personal booking links](https://www.app2email.com/docs/api/calendar/list-booking-links.md): GET /v1/{number}/bookings/links - [Make a link that opens the online booking page](https://www.app2email.com/docs/api/calendar/create-booking-link.md): POST /v1/{number}/bookings/links - [Revoke a personal booking link](https://www.app2email.com/docs/api/calendar/revoke-booking-link.md): DELETE /v1/{number}/bookings/links/{code} - [Keep a free time for a few minutes](https://www.app2email.com/docs/api/calendar/create-booking-hold.md): POST /v1/{number}/bookings/holds - [Release a held time](https://www.app2email.com/docs/api/calendar/release-booking-hold.md): DELETE /v1/{number}/bookings/holds/{reference} ## Payments - [The payments, newest first](https://www.app2email.com/docs/api/payments/list-payments.md): GET /v1/{number}/payments - [One payment](https://www.app2email.com/docs/api/payments/get-payment.md): GET /v1/{number}/payments/{id} - [Ask a customer to pay an amount](https://www.app2email.com/docs/api/payments/create-payment-link.md): POST /v1/{number}/payments/links - [Refund a payment, in full or a part](https://www.app2email.com/docs/api/payments/refund-payment.md): POST /v1/{number}/payments/{id}/refund - [Record a payment taken outside app2email](https://www.app2email.com/docs/api/payments/set-booking-payment.md): POST /v1/{number}/bookings/{id}/payment - [The prepaid packages on sale](https://www.app2email.com/docs/api/payments/list-packages.md): GET /v1/{number}/bookings/packages - [The packages customers hold](https://www.app2email.com/docs/api/payments/list-package-purchases.md): GET /v1/{number}/bookings/packages/purchases - [Give a customer a package without a payment](https://www.app2email.com/docs/api/payments/grant-package.md): POST /v1/{number}/bookings/packages/grant - [The customers with appointments](https://www.app2email.com/docs/api/payments/list-booking-customers.md): GET /v1/{number}/bookings/customers - [A customer's whole profile](https://www.app2email.com/docs/api/payments/get-customer-profile.md): GET /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): PATCH /v1/{number}/bookings/customers/{contact} - [Erase a customer's booking data](https://www.app2email.com/docs/api/payments/erase-customer-booking-data.md): DELETE /v1/{number}/bookings/customers/{contact} - [The meeting polls](https://www.app2email.com/docs/api/payments/list-polls.md): GET /v1/{number}/bookings/polls - [Offer several times and let people vote](https://www.app2email.com/docs/api/payments/create-poll.md): POST /v1/{number}/bookings/polls - [One poll with its votes](https://www.app2email.com/docs/api/payments/get-poll.md): GET /v1/{number}/bookings/polls/{id} - [Close a poll to new votes](https://www.app2email.com/docs/api/payments/close-poll.md): POST /v1/{number}/bookings/polls/{id}/close - [Pick the winning time](https://www.app2email.com/docs/api/payments/book-poll.md): POST /v1/{number}/bookings/polls/{id}/book ## Webhook events - [message.status](https://www.app2email.com/docs/api/webhooks/message.status.md): A message sent from the number was sent, delivered, read, failed or deleted. - [message.received](https://www.app2email.com/docs/api/webhooks/message.received.md): A contact sent a message or tapped a button. While WhatsApp's AI agent holds the conversation (owner whatsapp_ai) a reply goes through only after it passes the conversation on (conversation.owner_changed). - [message.failed](https://www.app2email.com/docs/api/webhooks/message.failed.md): A message sent from the number failed (the same data as message.status). - [contact.opted_out](https://www.app2email.com/docs/api/webhooks/contact.opted_out.md): A contact was added to the Do Not Call list by their own action. - [broadcast.completed](https://www.app2email.com/docs/api/webhooks/broadcast.completed.md): A broadcast finished sending, was cancelled, or its scheduled time was missed. - [usage.threshold](https://www.app2email.com/docs/api/webhooks/usage.threshold.md): 80% or 100% of the billing month's messages are used (once each per month). - [template.status_changed](https://www.app2email.com/docs/api/webhooks/template.status_changed.md): WhatsApp approved, rejected, paused or disabled a template, changed its quality or category, or it was edited (change components). WABA-wide: every number gets it. - [conversation.owner_changed](https://www.app2email.com/docs/api/webhooks/conversation.owner_changed.md): Who handles a contact changed: human, agent, paused or back to normal; or WhatsApp's AI agent took or passed on the conversation (owner whatsapp_ai). - [message.held_for_approval](https://www.app2email.com/docs/api/webhooks/message.held_for_approval.md): A send was held by the key's approval gate. - [approval.resolved](https://www.app2email.com/docs/api/webhooks/approval.resolved.md): A held send was approved (and sent), rejected, or expired. - [contact.updated](https://www.app2email.com/docs/api/webhooks/contact.updated.md): A contact was made or changed through the API (upsert, patch, consent; not imports), or turned marketing messages back on in WhatsApp. - [waitlist.joined](https://www.app2email.com/docs/api/webhooks/waitlist.joined.md): A customer joined the waitlist of a full day (on a personal booking link, confirmed on WhatsApp after the public page, in the calendar app or through the API). - [waitlist.notified](https://www.app2email.com/docs/api/webhooks/waitlist.notified.md): A customer on the waitlist was offered a time that opened (WhatsApp, the waitlist template or e-mail). - [waitlist.removed](https://www.app2email.com/docs/api/webhooks/waitlist.removed.md): A customer was taken off the waitlist (by themselves, the business or the API). - [booking.created](https://www.app2email.com/docs/api/webhooks/booking.created.md): An appointment was booked: by the customer in the WhatsApp Flow, on the dashboard, or through the API. - [booking.cancelled](https://www.app2email.com/docs/api/webhooks/booking.cancelled.md): An appointment was cancelled: by the customer (CANCEL on WhatsApp), the business, the API or app2email. - [booking.rescheduled](https://www.app2email.com/docs/api/webhooks/booking.rescheduled.md): An appointment was moved to another time (the old one is in rescheduled_from). - [booking.rated](https://www.app2email.com/docs/api/webhooks/booking.rated.md): The customer rated a completed appointment (the follow-up message's buttons). - [flow.completed](https://www.app2email.com/docs/api/webhooks/flow.completed.md): A contact finished a form Flow of the Book-and-Pay section (kind form); a booking Flow sends booking.created instead. - [booking.updated](https://www.app2email.com/docs/api/webhooks/booking.updated.md): An appointment's details changed: the customer's name or e-mail, the notes, the answers or the staff member (in the calendar app, on the dashboard or through the API). Not sent for a move (booking.rescheduled) or a cancel. - [booking.note.created](https://www.app2email.com/docs/api/webhooks/booking.note.created.md): An internal note was added to a customer or an appointment (in the calendar app or through the API). - [calendar.block.created](https://www.app2email.com/docs/api/webhooks/calendar.block.created.md): Time was blocked in the calendar (in the calendar app or through the API). - [calendar.block.deleted](https://www.app2email.com/docs/api/webhooks/calendar.block.deleted.md): A time block was removed from the calendar. - [call.incoming](https://www.app2email.com/docs/api/webhooks/call.incoming.md): A WhatsApp user calls the number (with their SDP offer). Answer with POST /calls within 30 to 60 s. - [call.status](https://www.app2email.com/docs/api/webhooks/call.status.md): A call rang, was accepted, rejected or connected, ended, or its recording or transcript is ready. - [message.edited](https://www.app2email.com/docs/api/webhooks/message.edited.md): A contact edited a message they sent. - [message.deleted](https://www.app2email.com/docs/api/webhooks/message.deleted.md): A contact deleted a message they sent. - [contact.changed_number](https://www.app2email.com/docs/api/webhooks/contact.changed_number.md): A contact changed their WhatsApp number, or their business-scoped user id changed. - [number.updated](https://www.app2email.com/docs/api/webhooks/number.updated.md): WhatsApp changed something about the number or its account: quality, messaging limit, throughput, display name, status, restriction, connection ... - [number.error](https://www.app2email.com/docs/api/webhooks/number.error.md): WhatsApp reported an error that is not about one message, eg too many messages in a short time. - [flow.status_changed](https://www.app2email.com/docs/api/webhooks/flow.status_changed.md): A flow was published, throttled, blocked or deprecated, Meta raised or cleared an endpoint or client alert, or its Flow JSON version expires soon. WABA-wide: every number gets it. - [client.created](https://www.app2email.com/docs/api/webhooks/client.created.md): A client signed up on your site, was made by POST /v1/partner/clients, or finished an onboarding link. (account and partner webhooks only) - [client.updated](https://www.app2email.com/docs/api/webhooks/client.updated.md): A client's name changed, or a suspended client is active again. (account and partner webhooks only) - [client.suspended](https://www.app2email.com/docs/api/webhooks/client.suspended.md): A client was suspended. (account and partner webhooks only) - [number.created](https://www.app2email.com/docs/api/webhooks/number.created.md): A number was connected (Meta's Embedded Signup finished). (account and partner webhooks only) - [number.ready](https://www.app2email.com/docs/api/webhooks/number.ready.md): A number went LIVE (once per number): it can send. (account and partner webhooks only) - [number.disconnected](https://www.app2email.com/docs/api/webhooks/number.disconnected.md): WhatsApp took app2email's access away (account offboarded, partner removed, deleted). (account and partner webhooks only) - [number.reconnected](https://www.app2email.com/docs/api/webhooks/number.reconnected.md): The number's WhatsApp account is connected again. (account and partner webhooks only) - [subscription.created](https://www.app2email.com/docs/api/webhooks/subscription.created.md): A client number got a plan (Stripe checkout, a free or a given plan). (account and partner webhooks only) - [subscription.renewed](https://www.app2email.com/docs/api/webhooks/subscription.renewed.md): A plan's period moved on (a renewal was paid). (account and partner webhooks only) - [subscription.payment_failed](https://www.app2email.com/docs/api/webhooks/subscription.payment_failed.md): A renewal could not be charged (status past_due or unpaid). (account and partner webhooks only) - [subscription.cancelled](https://www.app2email.com/docs/api/webhooks/subscription.cancelled.md): A plan ended (cancelled, unpaid, replaced by another plan, or ended by you). (account and partner webhooks only) - [trial.ending](https://www.app2email.com/docs/api/webhooks/trial.ending.md): A number's trial ends within 3 days. (account and partner webhooks only) - [trial.expired](https://www.app2email.com/docs/api/webhooks/trial.expired.md): A number's trial ended without a plan. (account and partner webhooks only) - [plan.limit_reached](https://www.app2email.com/docs/api/webhooks/plan.limit_reached.md): A number used all messages of its plan this billing period (once per period). (account and partner webhooks only) - [api_key.created](https://www.app2email.com/docs/api/webhooks/api_key.created.md): A key of a number was made (Partner API, account API or dashboard). (account and partner webhooks only) - [api_key.revoked](https://www.app2email.com/docs/api/webhooks/api_key.revoked.md): A key of a number was revoked. (account and partner webhooks only) - [booking.paid](https://www.app2email.com/docs/api/webhooks/booking.paid.md): An appointment was paid online (the payment provider confirmed it, or a deposit was paid). Not sent for a payment the business recorded by hand. - [booking.refunded](https://www.app2email.com/docs/api/webhooks/booking.refunded.md): An appointment's online payment was refunded, in full or in part (from the calendar, the API, or automatically when it is cancelled). - [payment.paid](https://www.app2email.com/docs/api/webhooks/payment.paid.md): A payment request or a package purchase was paid online. - [package.purchased](https://www.app2email.com/docs/api/webhooks/package.purchased.md): A prepaid package was bought online (paid) or given to a customer (granted). - [poll.voted](https://www.app2email.com/docs/api/webhooks/poll.voted.md): Someone voted (or changed their vote) on a meeting poll. - [poll.closed](https://www.app2email.com/docs/api/webhooks/poll.closed.md): A meeting poll was closed, or its winning time was booked (status booked, with chosen_option). - [booking.customer.erased](https://www.app2email.com/docs/api/webhooks/booking.customer.erased.md): A customer's booking data was erased on request (DELETE /bookings/customers/{contact}, the calendar app, or the contact delete with booking_data=erase). - [order.created](https://www.app2email.com/docs/api/webhooks/order.created.md): An order became real: placed to pay later, paid online, or confirmed on WhatsApp by a visitor of the order page. Not sent while an order still waits for its payment or its confirmation. - [order.paid](https://www.app2email.com/docs/api/webhooks/order.paid.md): The online payment of an order was confirmed by the payment provider. payment.paid is sent as well. - [order.accepted](https://www.app2email.com/docs/api/webhooks/order.accepted.md): The staff accepted an order by hand. An order that is accepted automatically says so in order.created (status accepted). - [order.ready](https://www.app2email.com/docs/api/webhooks/order.ready.md): An order was marked ready. - [order.completed](https://www.app2email.com/docs/api/webhooks/order.completed.md): An order was handed over at the counter or delivered. - [order.cancelled](https://www.app2email.com/docs/api/webhooks/order.cancelled.md): An order was cancelled by the customer or the staff, or declined by the staff. - [order.refunded](https://www.app2email.com/docs/api/webhooks/order.refunded.md): A refund of an order was recorded: from the dashboard, the counter, or one made in the payment provider's own dashboard. - [order.no_show](https://www.app2email.com/docs/api/webhooks/order.no_show.md): The staff closed a pickup order that was ready and never collected. The order's status is cancelled; order.cancelled is not sent for it. - [submission.created](https://www.app2email.com/docs/api/webhooks/submission.created.md): A submission was made: on WhatsApp, on the web page, by a team member or through the API. Its files may still be arriving (files_pending above 0): submission.files_ready follows. - [submission.files_ready](https://www.app2email.com/docs/api/webhooks/submission.files_ready.md): Every file of a submission is stored, so files[].url can be fetched. Sent once, and only for a submission that has files. - [submission.updated](https://www.app2email.com/docs/api/webhooks/submission.updated.md): Answers, internal values, the priority, the tags, the due time or the pin of a submission changed, a file was added to it by a team member or the API, or the submitter of a web submission proved their number. - [submission.status_changed](https://www.app2email.com/docs/api/webhooks/submission.status_changed.md): A submission moved to another stage: a team member, the API, an automation, or the submitter pressing a button. - [submission.assigned](https://www.app2email.com/docs/api/webhooks/submission.assigned.md): The assignee of a submission changed (to a member, or to nobody). - [submission.note_added](https://www.app2email.com/docs/api/webhooks/submission.note_added.md): A team member or the API wrote an internal note on a submission. - [submission.customer_replied](https://www.app2email.com/docs/api/webhooks/submission.customer_replied.md): The submitter added something to a submission: text or files after Add more or on their status page, a follow-up form, or a button of a reply. - [submission.deleted](https://www.app2email.com/docs/api/webhooks/submission.deleted.md): A submission was deleted (restorable for 30 days) or erased for good. - [submit.automation_failed](https://www.app2email.com/docs/api/webhooks/submit.automation_failed.md): An automation gave up on a submission: an outside call still failed after its retries (1 minute, 10 minutes, 1 hour). GET /submit/runs?status=failed has every step. - [ticket.order.confirmed](https://www.app2email.com/docs/api/webhooks/ticket.order.confirmed.md): An order's tickets were issued: paid online, free and confirmed, complimentary, or paid outside. Once per order. page_url is empty in events: read the order with GET /tickets/orders/{id}. - [ticket.order.refunded](https://www.app2email.com/docs/api/webhooks/ticket.order.refunded.md): Tickets of an order were refunded or cancelled: by staff, the API, a cancelled date, or a full refund made at the payment provider. Not sent for a late payment that was returned before any ticket existed. page_url is empty in events: read the order with GET /tickets/orders/{id}. - [ticket.checked_in](https://www.app2email.com/docs/api/webhooks/ticket.checked_in.md): A ticket was admitted for the first time (not for a re-entry, a check-out or a refused scan). page_url is empty in events: read the order with GET /tickets/orders/{id}. - [ticket.passed_on](https://www.app2email.com/docs/api/webhooks/ticket.passed_on.md): A holder passed a ticket on: the old ticket stopped working and a new one was made. page_url is empty in events: read the order with GET /tickets/orders/{id}. - [ticket.event.sold_out](https://www.app2email.com/docs/api/webhooks/ticket.event.sold_out.md): A date sold its last public ticket. Once per time it becomes sold out. - [ticket.event.cancelled](https://www.app2email.com/docs/api/webhooks/ticket.event.cancelled.md): A date was cancelled and its refunds have finished. Cancelling an event sends one per date. - [ticket.waitlist.joined](https://www.app2email.com/docs/api/webhooks/ticket.waitlist.joined.md): Someone joined the waiting list of a sold-out date. - [ticket.buyer.erased](https://www.app2email.com/docs/api/webhooks/ticket.buyer.erased.md): A buyer's ticket data was erased on request. ## Optional - [OpenAPI 3.0](https://www.app2email.com/docs/api/openapi.json) - [Postman collection](https://www.app2email.com/docs/api/postman.json) - [Whole reference in one file](https://www.app2email.com/docs-api.md) - [MCP server](https://api.app2email.com/mcp): Streamable HTTP, same Bearer key - [Site index](https://www.app2email.com/llms.txt)