Message the submitter, with up to 3 buttons

POST https://api.app2email.com/v1/{number}/submit/submissions/{id}/reply
scope: submissions:manage sandbox: refused MCP: reply_to_submission

Scope: submissions:manage. Not with a sandbox key. Sends text to the person who made the submission: on WhatsApp, or by e-mail when they gave only an e-mail address (by says which). When WhatsApp cannot take a normal message for them right now the reply is held (held true): they get a short notice, and the reply the moment they tap it or write to the number, exactly as a reply from the Inbox. buttons (up to 3) let them answer with one tap: each can move the submission to a stage (set_status), which is how a quote is accepted or a fix confirmed; a press arrives as submission.customer_replied. file sends a document or picture with it, link adds a button to their status page. A web submission whose number was never confirmed is answered by e-mail only. The reply is in the activity list and on the submitter's status page. 403 submit_not_enabled while Submit-Info is switched off; 502 whatsapp_error when it could not be sent at all.

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 submission's id, or its reference (MR-7Q3M2A).

    e.g. MR-7Q3M2A

Body application/json required

  • text string max 4000 chars

    The message. Needed unless a file is sent.

  • buttons object[] max 3 items

    Up to 3 buttons. Pressing one moves the submission to set_status (when given), sends submission.customer_replied and fires automations with the button trigger.

    3 item fields
    • id string

      Your name for the button: it comes back in reply.button. Left out: one is made.

      e.g. fixed
    • title string required max 20 chars
      e.g. Yes, fixed
    • set_status string

      A stage key of the form.

      e.g. resolved
  • file object

    A file sent with the reply. It is stored with the submission too.

    3 fields
    • name string required
      e.g. quote.pdf
    • mime string
      e.g. application/pdf
    • data string required

      The bytes, base64. 10 MB at most.

Responses

200 Sent or held.
Fields
  • success boolean
  • request_id string
  • sent boolean

    The message went out now.

  • held boolean

    WhatsApp cannot take a normal message for this person right now: the reply is kept, they get a short notice, and the reply itself the moment they tap it or write to the number. The same as a reply from the Inbox.

  • by string

    How it went: e-mail when the submitter left only an address, or WhatsApp could not be used.

    whatsappemail
  • event object

    One line of a submission's activity list. The list only grows.

    7 fields
    • id integer
    • kind string
      creatededitedstatusassignedprioritytagsduenotereply_outreply_infilelocationbuttonautomationfollowupvieweddeletedrestorederror
    • actor object

      Who did it.

      3 fields
      • kind string
        systemmembercontactapiautomation
      • id integer
      • name string
    • text string
    • data object any keys

      Details by kind, for example {from, to} of a stage change or {state: sent | held | email | failed} of a reply.

    • public boolean

      true: the submitter sees it on their status page.

    • created string (date-time)
  • note string

    Only when held.

Errors

api_key_expiredapi_key_number_mismatchapi_key_old_formatapi_key_revokedapproval_body_too_largeblock_list_busyblock_list_fullblock_users_errorblock_users_failedbsuid_not_supportedcall_permission_requiredcaption_not_supportedcaption_too_longdaily_cap_reacheddisplay_name_not_approvedform_not_foundfree_form_single_recipientinsufficient_scopeinternal_errorinvalid_api_keyinvalid_authorization_headerinvalid_base64invalid_callback_datainvalid_contacts_messageinvalid_cursorinvalid_identity_key_hashinvalid_interactiveinvalid_jsoninvalid_locationinvalid_media_linkinvalid_memberinvalid_number_in_urlinvalid_reactioninvalid_reply_toinvalid_submissioninvalid_toip_not_allowedmarketing_disabled_on_cloud_apimarketing_per_user_limitmedia_download_errormedia_download_failedmedia_too_largemedia_type_not_allowedmedia_upload_errormedia_upload_failedmember_not_foundmessaging_limit_restrictedmissing_api_keymissing_interactivemissing_mediamissing_textmonthly_cap_reachedmonthly_limit_reachednothing_to_changenumber_already_verifiednumber_not_foundoutside_24h_windowparameter_value_invalidplan_not_allowedrate_limitedreaction_too_oldrecipient_identity_changedrecipient_in_experimentrecipient_is_senderrecipient_not_allowedrecipient_opted_outrecipient_stopped_marketingrecipient_unreachableregister_limit_reachedrequired_parameter_missingsandbox_keyservice_not_livestage_not_allowedsubmission_not_foundsubmit_not_enabledsubmit_not_readytemplate_disabledtemplate_format_policytemplate_not_foundtemplate_not_marketingtemplate_parameter_count_mismatchtemplate_parameter_format_mismatchtemplate_parameter_invalidtemplate_pausedtemplate_text_too_longtext_too_longtoo_many_messages_to_recipientunsupported_message_typeusername_account_not_linkedusername_change_limitusername_not_availableusername_not_eligibleusername_takenvoice_needs_ogg_opuswhatsapp_account_lockedwhatsapp_account_restrictedwhatsapp_connection_problemwhatsapp_errorwhatsapp_maintenancewhatsapp_number_not_registeredwhatsapp_parameter_errorwhatsapp_payment_issuewhatsapp_rate_limitwhatsapp_unavailable
  • 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.
  • 413 The request or the media file is too large.
  • 415 The body is not JSON.
  • 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.

Webhooks it causes

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.