Create a list or replace its items
https://api.app2email.com/v1/{number}/submit/lists/{key} 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
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The list's key: lower case letters, digits and _, starting with a letter.
e.g.products
Body application/json required
-
Left out: the key.
e.g.Products -
ALL the items: they replace what is stored. Up to 1,000 items and 200 KB.
3 item fields
-
What is stored as the answer. Unique in the list.
e.g.pump-s - e.g.
Pump, small - description string
-
Responses
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.
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.