Create a list or replace its items

PUT https://api.app2email.com/v1/{number}/submit/lists/{key}
scope: submissions:manage sandbox: refused MCP: set_submit_list

Scope: submissions:manage. Not with a sandbox key. Makes the list when the key is new; otherwise replaces its name and ALL its items (send the full list every time, for example from a nightly sync of jobs or prices). Each item needs a unique id (stored as the answer) and a title (what people see; left out, the id); any other key is a column for formulas. A plain text instead of an object is an item whose id and title are that text. Up to 1,000 items and 200 KB; a form shows the first 200. Forms pick the change up at once: no publish is needed. A number has at most 50 lists.

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 list's key: lower case letters, digits and _, starting with a letter.

    e.g. products

Body application/json required

  • name string max 60 chars

    Left out: the key.

    e.g. Products
  • items object[] required max 1000 items

    ALL the items: they replace what is stored. Up to 1,000 items and 200 KB.

    3 item fields
    • id string required

      What is stored as the answer. Unique in the list.

      e.g. pump-s
    • title string required
      e.g. Pump, small
    • description string

Responses

200 Saved.
Fields
  • success boolean
  • request_id string
  • list object

    Choices kept outside the forms: sites, jobs, products with prices. A select field with list = this key shows them, read fresh each time the form opens.

    5 fields
    • key string
      e.g. products
    • name string
      e.g. Products
    • items object[]
      3 item fields
      • id string required

        What is stored as the answer. Unique in the list.

        e.g. pump-s
      • title string required
        e.g. Pump, small
      • description string
    • count integer
    • updated 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.
  • 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.