Account status and what is still needed

GET https://api.app2email.com/v1/account
scope: any key MCP: get_account_status

pending_email, pending_whatsapp, pending_payment or live, with the numbers and next steps. Works with the management_key before the person confirms.

Responses

200 The account.
Fields
  • success boolean
  • request_id string
  • account object
    6 fields
    • status string

      pending_email: the person has not confirmed. pending_whatsapp: no WhatsApp number yet, or a number with a plan is not LIVE (paused, being connected). pending_payment: no number has a plan with the API. live: at least one number is live.

      pending_emailpending_whatsapppending_paymentlive
    • email string | null

      Masked until the person confirms.

    • name string | null
    • numbers object[]
      10 item fields
    • signup_id string | null
    • signup_expires string (date-time) | null
  • key object
    3 fields
  • next_steps string[]

    What to do next, in plain words.

Errors

  • 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.
  • 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.
  • 502 WhatsApp (Meta) returned an error or could not be reached.
  • 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.