Attach a file to a submission
https://api.app2email.com/v1/{number}/submit/submissions/{id}/files Scope: submissions:manage. Not with a sandbox key. One file as base64, 10 MB at most (413 media_too_large above that): a report, a signed form, a photo taken later. With field it joins that photo or document field's files; without it, it is a loose file of the submission. The file type is worked out from the bytes, not from mime. A submission holds at most 60 files. submission.updated is sent with change.files.added, and automations with the trigger file_added run.
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
- field string
A photo or document field's key. Left out: a loose file of the submission.
- e.g.
report.pdf - mime stringe.g.
application/pdf -
The bytes, base64. 10 MB at most.
Responses
Fields
- success boolean
- request_id string
- file object
A file of a submission.
9 fields
- id integer
What a photo or document answer holds.
e.g.9917 - field string
The field it belongs to. Empty: added afterwards.
- name string
- mime string
- size integer
Bytes.
- state string
pending: still being fetched from WhatsApp. failed: could not be fetched.
pendingstoredfailed - source string
flow: the WhatsApp form. chat: sent in the chat afterwards.
flowwebchatstaffapi - url string
Fetches the file's bytes without a key. Valid for 7 days from this answer; read the submission again for a fresh one. Empty until the file is stored.
- created string (date-time)
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.
- 503 app2email's connection to the WhatsApp account needs attention, or the request log is not available right now.