number.updated

Send this to my URL
Number X-App2email-Event: number.updated

WhatsApp changed something about the number or its account: quality, messaging limit, throughput, display name, status, restriction, connection ...

data

  • change string required

    phone_number_quality_update: quality (FLAGGED, UNFLAGGED), messaging_limit (UPGRADE, DOWNGRADE), onboarding (the first limit), throughput (THROUGHPUT_UPGRADE); new_value is then the limit, eg TIER_10K or TIER_UNLIMITED.

    qualitymessaging_limitonboardingthroughputdisplay_nameaccount_statusaccount_reviewrestrictionviolationusernamecapabilityconnectionmarketing_messages_onboardingsecurityaccount
  • new_value string
  • details object any keys

    What WhatsApp sent with it (event, decision, rejection_reason, restriction_info ...).

  • next_step string

    reconnect: press Reconnect WhatsApp on the dashboard (a new display name, or the connection was lost).

    reconnect
  • whatsapp_field string required

    Meta's webhook field, eg phone_number_quality_update or account_update.

  • timestamp string (date-time)

Inside the envelope {id, type, created, number, test?, data}: envelope, headers, signature.

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.