Send a form to a contact, with values filled in

POST https://api.app2email.com/v1/{number}/submit/forms/{key}/send
scope: submissions:manage sandbox: refused MCP: send_form

Scope: submissions:manage. Not with a sandbox key. Sends the form to one contact, with prefill values you already know (a job number, an account, the documents wanted). The WhatsApp form goes out when the form is published and the contact wrote to the number in the last 24 hours; a form that is not published goes out as a message with a button to the contact's personal web link. Outside the 24 hour window, or when a form message went to the contact less than 2 minutes ago, nothing is sent: the answer is still 200 with sent false and note saying why. link is always returned: when nothing was sent, send it yourself, for example in an approved template. link_only true sends nothing and just returns the link. parent makes the new submission a follow-up of an earlier one. The answers arrive as submission.created. 403 submit_not_enabled while Submit-Info is switched off; 409 form_not_published when the form is switched off or archived; 403 recipient_opted_out when the contact asked not to be messaged.

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 form's key (GET /submit/forms).

    e.g. meter_reading

Body application/json required

  • to string required

    The contact's WhatsApp number with country code, digits only, or their business-scoped user id.

    e.g. 61412345678
  • name string

    Their name, when you know it.

    e.g. John Smith
  • prefill object any keys

    Values the form starts with: {key: value}. A field reads one with default {prefill.<key>}; a hidden field carries it into the submission unseen.

    e.g. {"job_no":"J-20931"}
  • parent string

    A submission (id or reference) the new one adds to: a follow-up.

    e.g. QR-4HT9XC
  • text string

    The message with the form button. Left out: the form's own trigger body.

Responses

200 Sent, or the link to send.
Fields
  • success boolean
  • request_id string
  • sent boolean

    A WhatsApp message went out. false: outside the contact's 24 hour window, a form message went to them less than 2 minutes ago, or link_only.

  • sent_flow boolean

    true: it was the WhatsApp form. false with sent true: a message with a button to the web form.

  • session_id integer

    This request to fill the form.

  • to string

    The contact, as it was understood.

  • note string

    What happened, and why nothing was sent when sent is false.

Errors

api_key_expiredapi_key_number_mismatchapi_key_old_formatapi_key_revokedblock_list_busyblock_list_fullblock_users_errorblock_users_failedbsuid_not_supportedcall_permission_requireddisplay_name_not_approvedform_not_foundform_not_publishedinsufficient_scopeinternal_errorinvalid_api_keyinvalid_authorization_headerinvalid_cursorinvalid_jsoninvalid_number_in_urlinvalid_submissioninvalid_toip_not_allowedmarketing_disabled_on_cloud_apimarketing_per_user_limitmedia_download_errormedia_upload_errormessaging_limit_restrictedmissing_api_keymonthly_limit_reachednumber_already_verifiednumber_not_foundoutside_24h_windowparameter_value_invalidplan_not_allowedrate_limitedrecipient_identity_changedrecipient_in_experimentrecipient_is_senderrecipient_not_allowedrecipient_opted_outrecipient_stopped_marketingrecipient_unreachableregister_limit_reachedrequired_parameter_missingsandbox_keyservice_not_livesubmission_not_foundsubmit_not_enabledsubmit_not_readytemplate_disabledtemplate_format_policytemplate_not_foundtemplate_not_marketingtemplate_parameter_count_mismatchtemplate_parameter_format_mismatchtemplate_parameter_invalidtemplate_pausedtemplate_text_too_longtoo_many_messages_to_recipientunsupported_message_typeusername_account_not_linkedusername_change_limitusername_not_availableusername_not_eligibleusername_takenwhatsapp_account_lockedwhatsapp_account_restrictedwhatsapp_connection_problemwhatsapp_errorwhatsapp_flow_failedwhatsapp_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.
  • 409 Idempotency-Key: the first request with this key is still running, or did not finish. Or a conflict: the template name exists, the webhook URL is used by another webhook, the broadcast cannot be cancelled, the booking slot is taken or the booking is already cancelled, or the Flow is not published.
  • 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.