Submit-Info settings: the switch, the config and the public code
https://api.app2email.com/v1/{number}/submit/settings Scope: submissions:manage. enabled says whether Submit-Info is switched on for the number (words, links and automations work only then; everything can be set up while it is off). config holds every setting with its value: the default reference prefix, the menu and status words, where e-mails go, the time zone, the look of the web pages, shared inbox views and the retention time. code is the number's public code in every form and inbox address.
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
- enabled boolean
Submit-Info is switched on for the number.
-
The number's Submit-Info settings.
11 fields
- business_name string
The {business} placeholder and the name on the web pages. "" = the number's verified name.
- default_prefix string
2 to 4 letters A-Z: the reference prefix of forms that have none.
e.g.SI -
A contact with a submission of the last 90 days who sends one of these gets its stage.
-
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
- color stringe.g.
#2DAE5C - background stringe.g.
#FFFFFF - hide_branding boolean
-
Saved inbox views the whole team shares.
-
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 - links object
The number's own addresses.
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.