Test a connection: can app2email reach it and sign in?

POST https://api.app2email.com/v1/{number}/submit/connections/{key}/test
scope: submissions:manage sandbox: real change MCP: test_connection

Scope: submissions:manage. A sandbox key may use it. Makes one real call from app2email's server: http reads the base address, openapi fetches the document, mcp opens a session with the server. The answer says whether it worked (ok), how far it got (stage), the HTTP status, the error in words and the time taken. A failed test answers 200 with ok false: read stage and error (stage is response when it worked). Nothing is changed in the outside system.

Path

  • number string required pattern ^[0-9]{8,15}$

    Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.

    e.g. 4976659348270
  • key string required

    The connection's key: lower case letters, digits and _, starting with a letter.

    e.g. erp

Responses

200 The test's result.
Fields
  • success boolean
  • request_id string
  • ok boolean
  • stage string

    Where the call ended, for example config (the connection cannot be used as saved), not_sent (refused before sending: a private address, the call limit), timeout, redirect, response (the system answered: status has its code).

    e.g. response
  • status integer

    The HTTP status of the outside system's answer. 0: no answer.

  • error string
  • ms integer

Errors

  • 400 The request is malformed (missing or invalid fields, query parameters or times).
  • 401 Missing, invalid, revoked or expired API key.
  • 403 The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account.
  • 404 The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found.
  • 429 A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait.
  • 500 Unexpected error on app2email's side.
  • 503 app2email's connection to the WhatsApp account needs attention, or the request log is not available right now.
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.