Sandbox

Instant sandbox: no account

  1. POST https://api.app2email.com/v1/account/sandbox (no key, no body) answers a key for the demo number 12025550100. MCP: create_sandbox on the Management MCP server.
  2. Send a template to a pretend customer: POST /v1/12025550100/messages. Nothing reaches WhatsApp.
  3. GET /v1/12025550100/events?wait=25 returns message.status sent, delivered, read, then the customer's answer as message.received.
12025550101Ava answers every message a few seconds later.
12025550102Ben reads and never answers: a free-form message to him is 422 outside_24h_window.
12025550103Cara: delivery fails (message.status failed, message.failed).
12025550104Dan answers STOP: contact.opted_out, then a marketing template to him is 403 recipient_opted_out.
12025550105Eve asks for a person: set the conversation's owner to human.

It has GET /me, GET /templates, POST /messages, GET /messages, GET /conversations, PUT /conversations/{contact}/owner, GET /events and POST /sandbox/inbound (a pretend customer writes now). Templates are checked by the same code as on a real number. Any other call: 403 not_in_instant_sandbox. A key lasts 7 days; its messages are kept 24 hours after the last call.

Sandbox key on your own number

  1. Create a key with Sandbox on (API key page), or a temporary key in the console.
  2. Same URL, same calls: POST /v1/{number}/messages answers "sandbox": true, ids wamid.SANDBOX.….
  3. Webhooks get message.status sent, delivered, read within seconds.

/v1/account/… and /v1/partner/… take an account or partner key, not a number key: no sandbox there.

simulated 4

every check runs for real; nothing reaches WhatsApp; the answer has "sandbox": true, ids start wamid.SANDBOX., message.status events follow

refused 125

answers 403 sandbox_key; use a live key

POST /v1/{number}/templates Create a template and submit it for approval
PATCH /v1/{number}/templates/{name} Edit a template (components, category, TTL, max price)
DELETE /v1/{number}/templates/{name} Delete a template (every language, or one)
PUT /v1/{number}/settings/autoreply Change the auto reply text
PUT /v1/{number}/settings/forwarding Change who gets the messages by email
PUT /v1/{number}/settings/optin Turn the opt-in rule for marketing on or off
PUT /v1/{number}/settings/number Change some of the number's settings
DELETE /v1/{number}/media/{id} Delete an uploaded file at WhatsApp
POST /v1/{number}/approvals/{id}/approve Approve a held send: it is sent now
POST /v1/{number}/approvals/{id}/reject Reject a held send: nothing is sent
POST /v1/{number}/conversions/dataset Create the Conversions API dataset
POST /v1/{number}/conversions/events Send conversion events of WhatsApp chats
POST /v1/{number}/bookings/waitlist Put a customer on the waitlist of a full day
POST /v1/{number}/bookings/waitlist/{reference}/remove Take a customer off the waitlist
POST /v1/{number}/bookings Book an appointment for a customer at a free slot
PATCH /v1/{number}/bookings/{id} Change an appointment's details
POST /v1/{number}/bookings/{id}/cancel Cancel an appointment
POST /v1/{number}/bookings/{id}/status Mark an appointment completed, a no-show, or back to confirmed
PUT /v1/{number}/settings/booking Switch Book-and-Pay on or off and change the settings
POST /v1/{number}/flows/{key}/send Send a Flow to a contact (the booking form or another form)
POST /v1/{number}/calendar/blocks Block time so that no one can book it
PATCH /v1/{number}/calendar/blocks/{id} Change a blocked time
DELETE /v1/{number}/calendar/blocks/{id} Remove a blocked time
POST /v1/{number}/bookings/{id}/reschedule Move an appointment to another time
POST /v1/{number}/bookings/{id}/notes Add an internal note to an appointment
POST /v1/{number}/bookings/notes Add an internal note to a customer
DELETE /v1/{number}/bookings/notes/{note_id} Delete an internal note
POST /v1/{number}/bookings/links Make a link that opens the online booking page
DELETE /v1/{number}/bookings/links/{code} Revoke a personal booking link
POST /v1/{number}/bookings/holds Keep a free time for a few minutes
DELETE /v1/{number}/bookings/holds/{reference} Release a held time
PATCH /v1/{number}/calling/settings Change the calling settings
POST /v1/{number}/calls Start, answer, reject or end a WhatsApp call
POST /v1/{number}/flows Create a flow (draft, or published at once)
PATCH /v1/{number}/flows/{id} Change a flow's name, categories or endpoint
DELETE /v1/{number}/flows/{id} Delete a draft flow
PUT /v1/{number}/flows/{id}/json Replace a flow's Flow JSON
POST /v1/{number}/flows/{id}/publish Publish a flow (cannot be undone)
POST /v1/{number}/flows/{id}/deprecate Deprecate a published flow (cannot be undone)
POST /v1/{number}/flows/{id}/preview A new preview link of a flow (the old one stops working)
PUT /v1/{number}/flows/encryption-key Set the number's public key for flow endpoints
POST /v1/{number}/blocked Block WhatsApp users
DELETE /v1/{number}/blocked Unblock WhatsApp users
DELETE /v1/{number}/contact-book/{bsuid} Remove a business-scoped user id from the contact book
PUT /v1/{number}/settings/identity-check Turn WhatsApp's identity change check on or off
PATCH /v1/{number}/profile Change the WhatsApp business profile
PUT /v1/{number}/profile/photo Change the profile photo from a public link
PUT /v1/{number}/profile/display-name Submit a new display name for Meta's review
POST /v1/{number}/profile/official-business-account Request an Official Business Account (blue tick)
PUT /v1/{number}/profile/india-compliance Set the India business compliance information
PUT /v1/{number}/username Adopt or change the business username
DELETE /v1/{number}/username Remove the business username
PUT /v1/{number}/settings/conversation-starters Set ice breakers, commands or the welcome message
POST /v1/{number}/qr-codes Create a QR code and wa.me short link
PATCH /v1/{number}/qr-codes/{code} Change a QR code's prefilled message
DELETE /v1/{number}/qr-codes/{code} Delete a QR code and its short link
PUT /v1/{number}/settings/commerce Turn the cart or the catalog icon on or off
PUT /v1/{number}/catalog Connect a product catalog
POST /v1/{number}/payments/links Ask a customer to pay an amount
POST /v1/{number}/payments/{id}/refund Refund a payment, in full or a part
POST /v1/{number}/bookings/{id}/payment Record a payment taken outside app2email
POST /v1/{number}/bookings/packages/grant Give a customer a package without a payment
PATCH /v1/{number}/bookings/customers/{contact} Change a customer's name, e-mail, tags or fields
DELETE /v1/{number}/bookings/customers/{contact} Erase a customer's booking data
POST /v1/{number}/bookings/polls Offer several times and let people vote
POST /v1/{number}/bookings/polls/{id}/close Close a poll to new votes
POST /v1/{number}/bookings/polls/{id}/book Pick the winning time
PUT /v1/{number}/shop/settings Change settings of the shop
POST /v1/{number}/shop/items Add a product
PUT /v1/{number}/shop/items/{id} Change a product: only the keys sent change
DELETE /v1/{number}/shop/items/{id} Archive a product
POST /v1/{number}/shop/items/{id}/stock Set or change the stock of a product
POST /v1/{number}/shop/items/{id}/sold_out Mark a product sold out for a while, or back
POST /v1/{number}/shop/orders Place an order for a customer
POST /v1/{number}/shop/orders/{id}/action Move an order on, change its time, cancel or decline it
POST /v1/{number}/shop/orders/{id}/refund Refund an order that was paid online
PUT /v1/{number}/submit/settings Switch Submit-Info on or off and change its settings
POST /v1/{number}/submit/setup Apply or dry-run a whole setup: forms, lists, automations
POST /v1/{number}/submit/forms Create a form from a definition or a preset
PUT /v1/{number}/submit/forms/{key} Change a form: name, on or off, archive, definition
DELETE /v1/{number}/submit/forms/{key} Delete a form (archived when it has submissions)
POST /v1/{number}/submit/forms/{key}/publish Publish a form to WhatsApp
POST /v1/{number}/submit/forms/{key}/send Send a form to a contact, with values filled in
PUT /v1/{number}/submit/lists/{key} Create a list or replace its items
DELETE /v1/{number}/submit/lists/{key} Delete a list
POST /v1/{number}/submit/submissions Create a submission from data you already hold
PATCH /v1/{number}/submit/submissions/{id} Change a submission: stage, assignee, tags, answers
DELETE /v1/{number}/submit/submissions/{id} Delete a submission, or erase it for good
POST /v1/{number}/submit/submissions/{id}/notes Write an internal note on a submission
POST /v1/{number}/submit/submissions/{id}/reply Message the submitter, with up to 3 buttons
POST /v1/{number}/submit/submissions/{id}/files Attach a file to a submission
POST /v1/{number}/submit/submissions/{id}/run Run a manual automation on a submission
POST /v1/{number}/submit/members Invite a person to the shared inbox by e-mail
PUT /v1/{number}/submit/members/{id} Change a member's role, abilities or forms
DELETE /v1/{number}/submit/members/{id} Remove a member from the inbox
POST /v1/{number}/submit/automations Create an automation: when, if, do
PUT /v1/{number}/submit/automations/{id} Change an automation, or switch it on or off
DELETE /v1/{number}/submit/automations/{id} Delete an automation
PUT /v1/{number}/submit/connections/{key} Create or change a connection (HTTP, OpenAPI or MCP)
DELETE /v1/{number}/submit/connections/{key} Delete a connection
POST /v1/{number}/submit/connections/{key}/refresh Read a connection's operations or tools again
POST /v1/{number}/templates/delete Delete several templates at once (all or nothing)
POST /v1/{number}/templates/{name}/archive Archive a template (deleted by WhatsApp after 28 days)
POST /v1/{number}/templates/{name}/unarchive Unarchive a template
PUT /v1/{number}/templates/{name}/authentication Create or update an authentication template in many languages
POST /v1/{number}/template-insights Switch template insights on (cannot be undone)
POST /v1/{number}/tickets/events Create an event as a draft with one date and one ticket type
PATCH /v1/{number}/tickets/events/{id} Change an event
POST /v1/{number}/tickets/events/{id}/publish Publish an event so tickets can be bought
POST /v1/{number}/tickets/events/{id}/cancel Cancel an event and refund or void its tickets
POST /v1/{number}/tickets/events/{id}/dates Add a date to an event
PATCH /v1/{number}/tickets/dates/{date_id} Change a date: time, label, capacity, sales on or paused
POST /v1/{number}/tickets/dates/{date_id}/cancel Cancel one date and refund or void its tickets
POST /v1/{number}/tickets/events/{id}/types Add a ticket type or an extra to an event
PATCH /v1/{number}/tickets/types/{type_id} Change or archive a ticket type
POST /v1/{number}/tickets/orders Issue complimentary tickets or record a sale paid outside
POST /v1/{number}/tickets/orders/{id}/refund Refund an order or some of its tickets
POST /v1/{number}/tickets/orders/{id}/resend Send the buyer their tickets again
POST /v1/{number}/tickets/issued/{id}/void Void one ticket without a refund
POST /v1/{number}/tickets/check-ins Check a ticket in (or out) by its code or id
POST /v1/{number}/tickets/check-ins/{scan_id}/undo Take a check-in back
POST /v1/{number}/tickets/codes Create a promo or access code
PATCH /v1/{number}/tickets/codes/{id} Change a promo code or switch it off
DELETE /v1/{number}/tickets/codes/{id} Delete a promo code no order has used
PUT /v1/{number}/settings/tickets Switch ticket sales on or off and change the settings

reads 130

reads real data

GET /v1/{number}/messages Messages sent and received, newest first
GET /v1/{number}/messages/{message_id} Status of a sent message
GET /v1/{number}/templates List your templates, with an example request for each
GET /v1/{number}/templates/{name} One template: status, rejection reason, what it needs
GET /v1/{number}/broadcasts Your latest broadcasts
GET /v1/{number}/broadcasts/{code} A broadcast's status and the result per number
GET /v1/{number}/broadcasts/{code}/results.csv A broadcast's result for each message, as CSV
GET /v1/{number}/me Check the key: its scopes, the number, the plan and the limits
GET /v1/{number}/requests The latest logged API requests
GET /v1/{number}/requests/{id} One logged request, by its request_id
GET /v1/{number}/conversations The contacts, most recent activity first
GET /v1/{number}/conversations/{phone}/messages One contact's messages, both directions
GET /v1/{number}/usage/history Messages and broadcasts per month
GET /v1/{number}/stats Message counts, delivery and read rates for a period
GET /v1/{number}/usage Plan, messages used and left, limits, what WhatsApp charges
GET /v1/{number}/donotcall The Do Not Call list, or check one number
GET /v1/{number}/settings/autoreply The auto reply to new contacts
GET /v1/{number}/settings/forwarding Who gets the messages by email
GET /v1/{number}/settings/optin Is the opt-in rule for marketing on?
GET /v1/{number}/optins The opt-in records, or check one number
GET /v1/{number}/conversations/{contact} One contact: window state, last messages, owner
GET /v1/{number}/settings/number The number's settings: email behaviour, caps, compliance
GET /v1/{number}/contacts Your contacts, newest first
GET /v1/{number}/contacts/export.csv All contacts as CSV
GET /v1/{number}/contacts/{identity} One contact
GET /v1/{number}/segments Your segments (saved contact filters)
GET /v1/{number}/segments/{id} One segment, with how many contacts match now
GET /v1/{number}/segments/{id}/contacts The contacts a segment matches now
GET /v1/{number}/compliance/export.csv Consent records, Do Not Call list and opt-ins as one CSV
GET /v1/{number}/usage/meta What WhatsApp charges this billing month, per day
GET /v1/{number}/media/{id} Download a received file (stored copy, else from WhatsApp)
GET /v1/{number}/approvals Sends held for approval
GET /v1/{number}/webhooks Your webhooks
GET /v1/{number}/webhooks/samples A sample of every event
GET /v1/{number}/webhooks/{id}/deliveries The last deliveries, with every attempt
GET /v1/{number}/webhooks/{id}/deliveries/{event_id} One delivery, with the event as it was sent
GET /v1/{number}/analytics/pricing WhatsApp cost and volume of this number
GET /v1/{number}/analytics/messages Messages sent and delivered, as WhatsApp counts them
GET /v1/{number}/activity The WhatsApp Business Account's activity log
GET /v1/{number}/conversions/dataset The Conversions API dataset of the account
GET /v1/{number}/conversions/dataset/quality Quality of the Conversions API dataset
GET /v1/{number}/bookings/waitlist The waitlist of full days
GET /v1/{number}/bookings The appointments, soonest start first
GET /v1/{number}/bookings/availability The free slots per day for a service, as the customer would see them
GET /v1/{number}/bookings/reports The booking report of a range of days
GET /v1/{number}/bookings/{id} One appointment, by id or reference
GET /v1/{number}/settings/booking The booking settings, the default Flow's status and every Flow
GET /v1/{number}/calendar Everything on the calendar for a range of days
GET /v1/{number}/calendar/blocks The blocked times
GET /v1/{number}/bookings/services The services a customer can book, and their staff
GET /v1/{number}/bookings/staff The staff members and the services they do
GET /v1/{number}/bookings/next The next free start times for a service, across days
GET /v1/{number}/bookings/{id}/notes The internal notes of an appointment and its customer
GET /v1/{number}/bookings/notes The internal notes of a customer
GET /v1/{number}/bookings/links The personal booking links
GET /v1/{number}/calling/settings WhatsApp calling settings
GET /v1/{number}/calls/permissions/{contact} May the number call this contact
GET /v1/{number}/events Fetch events (no webhook address needed)
GET /v1/{number}/flows List WhatsApp Flows
GET /v1/{number}/flows/{id} One flow: status, validation errors, health
GET /v1/{number}/flows/{id}/json A flow's Flow JSON
GET /v1/{number}/flows/{id}/preview A public preview link of a flow (30 days)
GET /v1/{number}/flows/encryption-key The number's public key for flows with a data endpoint
GET /v1/{number}/marketing Where marketing templates go: Cloud API or Marketing Messages API
GET /v1/{number}/blocked WhatsApp users this number blocked
GET /v1/{number}/contact-book/{bsuid} Is a phone number on file for a business-scoped user id
GET /v1/{number}/health Number health: can it send, quality, limit, name status
GET /v1/{number}/profile The WhatsApp business profile
GET /v1/{number}/profile/official-business-account Official Business Account (blue tick) status
GET /v1/{number}/profile/india-compliance India business compliance information
GET /v1/{number}/username The business username
GET /v1/{number}/username/suggestions Usernames reserved for the business
GET /v1/{number}/settings/conversation-starters Ice breakers, commands and welcome message
GET /v1/{number}/qr-codes QR codes and short links
GET /v1/{number}/qr-codes/{code} One QR code
GET /v1/{number}/settings/commerce Cart and catalog icon on or off
GET /v1/{number}/catalog The connected product catalog
GET /v1/{number}/payments The payments, newest first
GET /v1/{number}/payments/{id} One payment
GET /v1/{number}/bookings/packages The prepaid packages on sale
GET /v1/{number}/bookings/packages/purchases The packages customers hold
GET /v1/{number}/bookings/customers The customers with appointments
GET /v1/{number}/bookings/customers/{contact} A customer's whole profile
GET /v1/{number}/bookings/polls The meeting polls
GET /v1/{number}/bookings/polls/{id} One poll with its votes
GET /v1/{number}/shop The shop: on or off, open now, the order page, counts and limits
GET /v1/{number}/shop/settings Every setting of the shop, as the shop uses it
GET /v1/{number}/shop/categories The categories of the catalog
GET /v1/{number}/shop/items Search and filter the products
GET /v1/{number}/shop/items/{id} One product with variants, option groups and pictures
GET /v1/{number}/shop/orders The orders, newest first
GET /v1/{number}/shop/orders/{id} One order with lines, payment, next steps and history
POST /v1/{number}/shop/quote Price a cart: total, problems, times and ways to pay
GET /v1/{number}/shop/report The shop's figures for a range of days
POST /v1/{number}/shop/link A customer's personal link to the order page
GET /v1/{number}/submit/guide The Submit-Info guide for agents: every key, rule and example
GET /v1/{number}/submit/settings Submit-Info settings: the switch, the config and the public code
GET /v1/{number}/submit/presets The ready-made setups (presets), or one complete preset
GET /v1/{number}/submit/forms The forms of the number
GET /v1/{number}/submit/forms/{key} One form: definition, fields, links and WhatsApp state
GET /v1/{number}/submit/lists The choice lists (sites, jobs, price lists)
GET /v1/{number}/submit/submissions The submissions, filtered and paged (JSON or CSV)
GET /v1/{number}/submit/submissions/{id} One submission with files, activity and what can be done
GET /v1/{number}/submit/members The team: who works in the shared inbox
GET /v1/{number}/submit/automations The automations
GET /v1/{number}/submit/automations/{id} One automation
GET /v1/{number}/submit/runs The automation run log, step by step
GET /v1/{number}/submit/connections The connections to outside systems
GET /v1/{number}/submit/connections/{key}/functions What an action can call on a connection
GET /v1/{number}/submit/report Submission counts by form, stage, day and assignee
GET /v1/{number}/templates/{name}/compare Compare two templates: block rate, sends, top block reason
GET /v1/{number}/template-previews Authentication template texts, per language
GET /v1/{number}/template-library Meta's Template Library (pre-approved templates)
GET /v1/{number}/template-insights Template insights: sent, delivered, read, clicked, cost
GET /v1/{number}/tickets/events The events, newest first
GET /v1/{number}/tickets/events/{id} One event with its dates and ticket types
GET /v1/{number}/tickets/events/{id}/dates The dates of an event with what is sold and left
GET /v1/{number}/tickets/dates/{date_id}/door The door list of a date for your own scanner
GET /v1/{number}/tickets/events/{id}/types The ticket types and extras of an event
GET /v1/{number}/tickets/events/{id}/availability What is on sale and how many are left for a date
GET /v1/{number}/tickets/orders The ticket orders, newest first
GET /v1/{number}/tickets/orders/{id} One order with its tickets, by id or reference
GET /v1/{number}/tickets/issued The tickets (attendees) with their check-in state
GET /v1/{number}/tickets/issued/{id} One ticket
GET /v1/{number}/tickets/codes The promo and access codes with their uses
GET /v1/{number}/tickets/waitlist The waiting list of a sold-out date
GET /v1/{number}/tickets/stats Sales and check-in figures of an event or one date
GET /v1/{number}/settings/tickets The ticket settings and whether ticket sales are switched on
GET /v1/{number}/webhooks/catchers Your catchers
GET /v1/{number}/webhooks/catchers/{token} What a catcher received

real change 24

changes real data, also with a sandbox key

POST /v1/{number}/broadcasts/{code}/cancel Cancel a scheduled or sending API broadcast
POST /v1/{number}/donotcall Add numbers to the Do Not Call list
DELETE /v1/{number}/donotcall/{phone} Remove a number from the Do Not Call list
POST /v1/{number}/optins Record that people opted in
DELETE /v1/{number}/optins/{phone} Remove an opt-in record
PUT /v1/{number}/conversations/{contact}/owner Hand a contact over: human, agent, paused, or back to normal
POST /v1/{number}/contacts Make or update contacts (one, or a list of up to 1000)
POST /v1/{number}/contacts/import Import contacts from CSV or JSON (up to 5000 rows)
PATCH /v1/{number}/contacts/{identity} Change a contact
POST /v1/{number}/contacts/{identity}/consent Record consent (or its withdrawal) with evidence
POST /v1/{number}/segments Save a contact filter as a segment
PUT /v1/{number}/segments/{id} Rename a segment or replace its filter
DELETE /v1/{number}/segments/{id} Delete a segment (its contacts stay)
POST /v1/{number}/webhooks Get events at your URL
PATCH /v1/{number}/webhooks/{id} Change a webhook: url, active, headers, format
DELETE /v1/{number}/webhooks/{id} Delete a webhook
POST /v1/{number}/webhooks/{id}/test Send a test event now
POST /v1/{number}/webhooks/{id}/rotate-secret Make a new signing secret
POST /v1/{number}/webhooks/{id}/deliveries/{event_id}/redeliver Send a stored event again
POST /v1/{number}/submit/automations/try Try an automation on a real submission, saving and sending nothing
POST /v1/{number}/submit/connections/{key}/test Test a connection: can app2email reach it and sign in?
POST /v1/{number}/webhooks/test-url Send a test event to any URL
POST /v1/{number}/webhooks/catchers Get a temporary URL that keeps what it receives
DELETE /v1/{number}/webhooks/catchers/{token} Delete a catcher
For AI Agents

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

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

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