Send a form to a contact, with values filled in
https://api.app2email.com/v1/{number}/submit/forms/{key}/send Scope: submissions:manage. Not with a sandbox key. Sends the form to one contact, with prefill values you already know (a job number, an account, the documents wanted). The WhatsApp form goes out when the form is published and the contact wrote to the number in the last 24 hours; a form that is not published goes out as a message with a button to the contact's personal web link. Outside the 24 hour window, or when a form message went to the contact less than 2 minutes ago, nothing is sent: the answer is still 200 with sent false and note saying why. link is always returned: when nothing was sent, send it yourself, for example in an approved template. link_only true sends nothing and just returns the link. parent makes the new submission a follow-up of an earlier one. The answers arrive as submission.created. 403 submit_not_enabled while Submit-Info is switched off; 409 form_not_published when the form is switched off or archived; 403 recipient_opted_out when the contact asked not to be messaged.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The form's key (GET /submit/forms).
e.g.meter_reading
Body application/json required
-
The contact's WhatsApp number with country code, digits only, or their business-scoped user id.
e.g.61412345678 - name string
Their name, when you know it.
e.g.John Smith -
Values the form starts with: {key: value}. A field reads one with default {prefill.<key>}; a hidden field carries it into the submission unseen.
e.g.{"job_no":"J-20931"} - parent string
A submission (id or reference) the new one adds to: a follow-up.
e.g.QR-4HT9XC - text string
The message with the form button. Left out: the form's own trigger body.
-
true: send nothing, only make the personal link and return it.
Responses
Fields
- success boolean
- request_id string
- sent boolean
A WhatsApp message went out. false: outside the contact's 24 hour window, a form message went to them less than 2 minutes ago, or link_only.
- sent_flow boolean
true: it was the WhatsApp form. false with sent true: a message with a button to the web form.
- link string
The contact's personal web link to the form: they are known, and the prefill values are in it. Send it yourself when sent is false.
- session_id integer
This request to fill the form.
- to string
The contact, as it was understood.
- note string
What happened, and why nothing was sent when sent is false.
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.
- 409 Idempotency-Key: the first request with this key is still running, or did not finish. Or a conflict: the template name exists, the webhook URL is used by another webhook, the broadcast cannot be cancelled, the booking slot is taken or the booking is already cancelled, or the Flow is not published.
- 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.
- 502 WhatsApp (Meta) returned an error or could not be reached.
- 503 app2email's connection to the WhatsApp account needs attention, or the request log is not available right now.