One flow: status, validation errors, health

GET https://api.app2email.com/v1/{number}/flows/{id}
scope: messages:read sandbox: reads MCP: get_flow

Status, categories, validation errors, Flow JSON version, endpoint, and whether it can be sent (health_status).

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
  • id string required

    The flow's id (digits).

    e.g. 1234567890123456

Responses

200 The flow.
Fields
  • success boolean
  • request_id string
  • flow object
    12 fields
    • id string
    • name string
    • status string
      DRAFTPUBLISHEDDEPRECATEDBLOCKEDTHROTTLED
    • categories string[]
      SIGN_UPSIGN_INAPPOINTMENT_BOOKINGLEAD_GENERATIONCONTACT_USCUSTOMER_SUPPORTSURVEYOTHER
    • 8 item fields
    • json_version string
    • endpoint_uri string
    • health_status object any keys

      can_send_message (AVAILABLE | LIMITED | BLOCKED) per entity, with errors.

    • key string

      GET /flows only: one of this number's Book-and-Pay Flows; POST /flows/{key}/send takes the key. Left out for other Flows.

      e.g. booking
    • can_send boolean

      GET /flows, a Book-and-Pay Flow: POST /flows/{key}/send works now (enabled and published).

    • booking_flow object

      GET /flows, a Book-and-Pay Flow: the Flow as the Book-and-Pay section has it (status in its words).

      14 fields
      • key string

        The Flow's key: what POST /flows/{key}/send takes.

        e.g. booking
      • name string
        e.g. Appointment booking
      • kind string
        bookingform
      • enabled boolean
      • is_default boolean

        The Flow the generic trigger words send.

      • Words that send this Flow.

      • id string

        Meta's id of the Flow, once uploaded.

      • status string

        Meta's status. Only a published Flow can be sent.

        nonedraftpublisheddeprecatedblockedthrottlederror
      • can_send boolean

        enabled and published.

      • health string

        Meta's health word: AVAILABLE, LIMITED, BLOCKED, or empty.

      • validation string

        Meta's validation problems in words, when there are any.

      • last_error string
      • updated_at string (date-time)

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.
  • 422 The request is understood but cannot be sent (template parameters, media, text, recipient, or a WhatsApp rule such as the 24 hour window).
  • 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.