Switch Submit-Info on or off and change its settings

PUT https://api.app2email.com/v1/{number}/submit/settings
scope: submissions:manage sandbox: refused MCP: update_submit_settings

Scope: submissions:manage. Not with a sandbox key. Send enabled, config, or both (400 nothing_to_change with neither). config is partial: only the keys you send change. A section such as brand is merged key by key; a list such as menu_words or views replaces what is stored. The result is checked as a whole (400 invalid_settings with the problems in error.details; nothing is saved then). Switching on makes the forms' words and links answer; a form still needs POST /submit/forms/{key}/publish to open inside WhatsApp.

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

Body application/json required

  • enabled boolean

    Switches Submit-Info on or off for the number: words, links and automations.

  • config object more keys allowed

    The number's Submit-Info settings.

    11 fields
    • The {business} placeholder and the name on the web pages. "" = the number's verified name.

    • 2 to 4 letters A-Z: the reference prefix of forms that have none.

      e.g. SI
    • menu_words string[] max 10 items

      A contact who sends one of these gets the form (one form) or a menu of the forms (several). [] = no menu.

    • menu_text string

      The text above the menu.

    • status_words string[] max 5 items

      A contact with a submission of the last 90 days who sends one of these gets its stage.

    • other_words_limit integer 0–100 default 10

      A form's word starts the form only when the message has fewer than this many other words, so a long message never starts a form. 0 = a message of any length. Menu and status words also need a message of at most 5 words.

    • notify_email string

      Where the business's e-mails go. "" = the number's Default To address. "off" = none.

    • timezone string

      "" = the number's time zone.

      e.g. Australia/Sydney
    • brand object

      The look of the web form and the status page.

      3 fields
    • views object[] max 20 items

      Saved inbox views the whole team shares.

      3 item fields
    • retention_days integer default 0

      For forms that set none: 0 = keep, else closed submissions are erased after this many days (30 to 3650).

Responses

200 Saved: the settings as they are now.
Fields
  • success boolean
  • request_id string
  • enabled boolean

    Submit-Info is switched on for the number.

  • config object more keys allowed

    The number's Submit-Info settings.

    11 fields
    • The {business} placeholder and the name on the web pages. "" = the number's verified name.

    • 2 to 4 letters A-Z: the reference prefix of forms that have none.

      e.g. SI
    • menu_words string[] max 10 items

      A contact who sends one of these gets the form (one form) or a menu of the forms (several). [] = no menu.

    • menu_text string

      The text above the menu.

    • status_words string[] max 5 items

      A contact with a submission of the last 90 days who sends one of these gets its stage.

    • other_words_limit integer 0–100 default 10

      A form's word starts the form only when the message has fewer than this many other words, so a long message never starts a form. 0 = a message of any length. Menu and status words also need a message of at most 5 words.

    • notify_email string

      Where the business's e-mails go. "" = the number's Default To address. "off" = none.

    • timezone string

      "" = the number's time zone.

      e.g. Australia/Sydney
    • brand object

      The look of the web form and the status page.

      3 fields
    • views object[] max 20 items

      Saved inbox views the whole team shares.

      3 item fields
    • retention_days integer default 0

      For forms that set none: 0 = keep, else closed submissions are erased after this many days (30 to 3650).

  • code string

    The number's public code: the part of every form and inbox address that names the number.

    e.g. k3xbq9rtzp2mwv7

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