Create a submission from data you already hold

POST https://api.app2email.com/v1/{number}/submit/submissions
scope: submissions:manage sandbox: refused Idempotency-Key MCP: create_submission

Scope: submissions:manage. Not with a sandbox key. For a system that already has the answers (a web shop, a call centre, an import). form is the form's key; answers are checked exactly like a customer's (required fields, ranges, choice ids: 400 invalid_submission names each field in error.details); extra fills internal fields; files attach base64 files to photo and document fields (up to 20 in one request, 10 MB each); assignee and location are optional. The submission gets a reference, starts in the form's first stage (or status), has channel api, and runs the form's automations like any other. No message is sent to the contact by this call itself; the form's automations may send one. submission.created is sent. Send an Idempotency-Key header to retry safely: the same key and body within 24 hours gets the first answer again.

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

Headers

  • Idempotency-Key string max 255 chars

    A unique value for this message or list (eg a UUID). The same request with the same key within 24 hours gets the first answer again, and nothing is sent twice. Ignored by dry runs.

    e.g. order-1234-shipped

Body application/json required

  • form string required

    The form's key. An archived form takes no submissions.

    e.g. meter_reading
  • contact string

    The person's WhatsApp number with country code, digits only, or their business-scoped user id. Left out: a submission without a WhatsApp contact.

    e.g. 61412345678
  • contact_name string
  • contact_email string (email)
  • answers object required any keys

    Field key -> value, typed as the field types say. Checked like a customer's answers: required fields, ranges, choice ids.

  • extra object any keys

    Values for internal fields, and anything else to keep with it.

  • status string

    A stage key to start in. Left out: the form's first stage.

  • assignee integer

    A member's id (GET /submit/members) to assign it to at once.

    e.g. 12
  • location object

    Where it is: a pin and / or an address. lat and lng come together.

    4 fields
  • files object[] max 20 items

    Files for photo and document fields: up to 20 in one request, 10 MB each. Add more with POST /submit/submissions/{id}/files.

    4 item fields
    • field string

      The field's key.

    • name string required
      e.g. meter.jpg
    • mime string
      e.g. image/jpeg
    • data string required

      The bytes, base64.

Responses

201 Made.
Fields
  • success boolean
  • request_id string
  • submission object

    What a person sent with a form, and everything that happened to it since. Lists carry the object up to closed; one submission (GET /submit/submissions/{id}) adds files, events, fields, stages, actions and buttons. The data of every submission.* webhook event is this object without events, fields, stages and actions.

    34 fields
    • id integer
      e.g. 4182
    • reference string

      The short code the submitter sees: the form's prefix and 6 characters. Every route that takes a submission id takes it too.

      e.g. MR-7Q3M2A
    • form object

      The form it was made with.

      2 fields
    • channel string

      whatsapp: the WhatsApp form. web: the web page. api: POST /submit/submissions. staff: entered by a team member.

      whatsappwebapistaff
    • status string

      The key of the stage it is in (the form's stages).

      e.g. received
    • status_name string
      e.g. Received
    • status_kind string
      opendonecancelled
    • status_color string
      greybluegreenamberredpurple
    • priority string
      lownormalhighurgent
    • tags string[]
    • due string (date-time) | null

      The due time, or null.

    • assignee object | null

      The member it is assigned to, or null.

      2 fields
    • contact object
      5 fields
      • identity string

        The submitter's WhatsApp number (digits, country code first) or business-scoped user id. Empty for a web submission with only an e-mail address.

        e.g. 61412345678
      • name string
      • phone string
      • email string
      • verified boolean

        true: the number is proven (sent on WhatsApp, or confirmed from the web page with one message).

    • The WhatsApp conversation. 0 when there is none.

    • answers object any keys

      What was asked: field key -> value. The value's JSON type follows the field type (text: string, number and rating: number, yesno and consent: boolean, multiselect: array of choice ids, photo and document: array of file ids, date: YYYY-MM-DD, location: the address text).

    • extra object any keys

      Everything that was not asked: internal fields, calculated values and values automations saved.

    • location object | null

      The pin the submitter sent, or null.

      4 fields
    • parent string | null

      The reference of the submission this one adds to (a follow-up form), or null.

    • summary string

      One line for lists: the first answers.

    • files_count integer
    • files_pending integer

      Files of the WhatsApp form that are still being fetched. 0 = all stored.

    • unread boolean

      New, or the submitter added something staff have not opened yet.

    • created string (date-time)
    • updated string (date-time)
    • status_changed string (date-time)
    • closed string (date-time) | null

      When it reached a done or cancelled stage, or null.

    • deleted string (date-time)

      Only on a deleted submission: when it was deleted.

    • files object[]

      One submission only (and webhook events).

      9 item fields
      • id integer

        What a photo or document answer holds.

        e.g. 9917
      • field string

        The field it belongs to. Empty: added afterwards.

      • name string
      • mime string
      • size integer

        Bytes.

      • state string

        pending: still being fetched from WhatsApp. failed: could not be fetched.

        pendingstoredfailed
      • source string

        flow: the WhatsApp form. chat: sent in the chat afterwards.

        flowwebchatstaffapi
      • url string

        Fetches the file's bytes without a key. Valid for 7 days from this answer; read the submission again for a fresh one. Empty until the file is stored.

      • created string (date-time)
    • events object[]

      The activity list, oldest first. One submission only.

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

        Who did it.

        3 fields
      • 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)
    • fields object[]

      The form's fields, to label answers and extra. One submission only.

      8 item fields
      • key string
      • label string
      • type string
        texttextareanumberemailphonedateselectmultiselectyesnoratingconsentphotodocumentlocationinfohidden
      • step string

        The key of its step. Empty for a calculated field.

      • internal boolean

        true: its value is in extra, not in answers.

      • unit string
      • choices object[]

        select and multiselect.

      • calculated boolean

        true: worked out by a formula.

    • stages object[]

      The stages it can move to. One submission only.

      7 item fields
      • key string required pattern ^[a-z][a-z0-9_]{0,39}$

        The stage's name in the API (the submission's status): a lower case letter, then lower case letters, digits or _ (at most 40 characters). Unique in the form.

        e.g. received
      • name string required

        What people see, for example In review. Up to 40 characters.

        e.g. Received
      • kind string required

        open: still being worked on. done: finished well. cancelled: finished without a result. A form needs at least one open and one done stage.

        opendonecancelled
      • color string

        grey, blue, green, amber, red or purple.

        greybluegreenamberredpurple
      • set_by string[]

        The roles that may choose this stage: some of owner, admin, manager, agent, viewer. [] = anyone who may change stages. Owners, admins, automations and API keys always may.

      • require_note boolean

        true: a note must come with the move to this stage.

      • message string max 1000 chars

        Sent to the submitter when the submission arrives in this stage, up to 1,000 characters, with placeholders ({note} = the note of the change). "" = nothing is sent.

    • actions object[]

      The manual automations of its form: POST /submit/submissions/{id}/run with the id. One submission only.

      2 item fields
    • buttons object[]

      Buttons sent to the submitter that they have not pressed yet. One submission only (and webhook events).

      2 item fields
  • changed boolean

    PATCH only. false: the submission already had these values.

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_recipientidempotency_key_reusedidempotency_request_in_progressidempotency_request_interruptedinsufficient_scopeinternal_errorinvalid_api_keyinvalid_authorization_headerinvalid_base64invalid_callback_datainvalid_contacts_messageinvalid_cursorinvalid_idempotency_keyinvalid_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.
  • 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.
  • 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.
  • 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.