Message the submitter, with up to 3 buttons
https://api.app2email.com/v1/{number}/submit/submissions/{id}/reply Scope: submissions:manage. Not with a sandbox key. Sends text to the person who made the submission: on WhatsApp, or by e-mail when they gave only an e-mail address (by says which). When WhatsApp cannot take a normal message for them right now the reply is held (held true): they get a short notice, and the reply the moment they tap it or write to the number, exactly as a reply from the Inbox. buttons (up to 3) let them answer with one tap: each can move the submission to a stage (set_status), which is how a quote is accepted or a fix confirmed; a press arrives as submission.customer_replied. file sends a document or picture with it, link adds a button to their status page. A web submission whose number was never confirmed is answered by e-mail only. The reply is in the activity list and on the submitter's status page. 403 submit_not_enabled while Submit-Info is switched off; 502 whatsapp_error when it could not be sent at all.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The submission's id, or its reference (MR-7Q3M2A).
e.g.MR-7Q3M2A
Body application/json required
-
The message. Needed unless a file is sent.
- file object
A file sent with the reply. It is stored with the submission too.
-
true: add a button that opens the submitter's own page with the status and the history.
Responses
Fields
- success boolean
- request_id string
- sent boolean
The message went out now.
- held boolean
WhatsApp cannot take a normal message for this person right now: the reply is kept, they get a short notice, and the reply itself the moment they tap it or write to the number. The same as a reply from the Inbox.
- by string
How it went: e-mail when the submitter left only an address, or WhatsApp could not be used.
whatsappemail - event object
One line of a submission's activity list. The list only grows.
7 fields
- id integer
- kind string
creatededitedstatusassignedprioritytagsduenotereply_outreply_infilelocationbuttonautomationfollowupvieweddeletedrestorederror - actor object
Who did it.
- text string
-
Details by kind, for example {from, to} of a stage change or {state: sent | held | email | failed} of a reply.
- public boolean
true: the submitter sees it on their status page.
- created string (date-time)
- note string
Only when held.
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.
- 413 The request or the media file is too large.
- 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.