The Submit-Info guide for agents: every key, rule and example
https://api.app2email.com/v1/{number}/submit/guide Scope: submissions:manage. Start here. One JSON document with everything needed to set Submit-Info up without reading anything else: every key of a form definition with its default and limit, the field types and how WhatsApp shows each, stage rules, rule operators, the automation triggers and actions with their keys and an example each, placeholders, formula functions, connection kinds, roles and abilities, limits, the presets, and three complete worked setups. this_number names the forms, lists and connections the number already has, so nothing is replaced by accident. Next: write a setup document and send it to POST /submit/setup with dry_run true.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Responses
Fields
- success boolean
- request_id string
-
Everything an agent needs to configure Submit-Info, as one JSON document. product, summary; how_to (the five steps in order); form {keys (every key of the definition), key_rule, field_keys (the keys every field takes), field_types [{type, value, keys, whatsapp, notes}], internal_types, reserved_keys, whatsapp, stage {keys, example}, rule {shape, operators, groups, comparing, in_show_if, in_automations, example}}; automation {keys, triggers [{trigger, when, options}], trigger_options, actions [{type, does, keys, example}], placeholders [{name, is}], placeholder_notes, formula {language, functions [{name, usage, does}], examples}, json_path, limits}; connection {keys, kinds [{kind, use}], auth_types [{type, use}], limits, example}; member {keys, roles {role: [abilities]}, abilities, notes}; settings {enabled, config}; limits; setup {shape, order, replaces}; presets [{key, name, description, category}]; examples (three complete setup documents: a meter reading form that posts to a billing API, a quote request, a field job report that calls an MCP tool); this_number (what the number already has). Keys may be added over time.
13 fields
- product string
- summary string
- how_to string[]
- presets object[]
4 item fields
- key stringe.g.
quote - name stringe.g.
Quote request - description string
- category string
- examples object[]
2 item fields
- title string
- setup object
A whole solution in one document: settings, lists, connections, forms and automations, applied in that order. Every part is optional. What already exists under the same key is REPLACED: lists, connections and forms by
key, automations bynamewithin the same form. Parts and keys the document does not name are left alone. The document is checked as a whole (each form, each automation, and the links between them: a select's list, an action's connection, form, stage and field keys). With any problem nothing is written.presetin place of the parts installs a ready-made solution (GET /submit/presets).e.g.{"dry_run":true,"settings":{"enabled":true},"lists":[{"key":"products","name":"…
- this_number object
The keys already in use on this number.
4 fields
- enabled boolean
- forms string[]
- lists string[]
- connections string[]
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.
- 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.