Check a setup file (changes nothing)
https://api.app2email.com/v1/{number}/setup/check Scope: the manage scope of each product in the file (bookings:manage for booking, submissions:manage for submit, orders:manage for shop, tickets:manage for tickets). Reads the file (JSON Lines, ZIP, or JSON with jsonl, lines or url) and checks every record with the product's own rules. Nothing is changed. problems lists each one with its line; plan says what an apply would create, change and remove. When ok is true, check_id applies exactly this file within 1 hour. A sandbox key may check.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Query
- mode string
merge (default): create or change what the file names. replace: also remove, of each record type in the file, what it does not name.
mergereplace - if_unchanged boolean
true: refuse (409 setup_changed) when the setup changed after the export the file came from.
- stock string
Order-and-Pay: ignore (default) leaves stock figures as they are; set writes the file's stock_qty values.
ignoreset
Body application/json | application/jsonl | application/zip required
- jsonl string
The file as JSON Lines text.
- lines object[]
Instead of jsonl: the records as objects.
- url string
Instead of jsonl: an https address of the file (.jsonl or .zip).
- check_id integer
apply only: the check_id of a check without problems (then no file).
- mode string
mergereplace - if_unchanged boolean
- stock string
Order-and-Pay: ignore (default) leaves stock figures as they are; set writes the file's stock_qty values (a ledger row each).
ignoreset - enable boolean
apply only: switch the products of the file on.
- publish string[]
apply only: Submit-Info form keys to publish to WhatsApp.
Responses
Fields
- e.g.
true - e.g.
s3tup - ok boolean
- check_id integer | null
Apply it within 1 hour (null when there are problems).
- products string[]
- mode string
- problems object[]
7 item fields
- problem_count integer
-
Per product: counts {create, change, unchanged, remove} and the keys ("<type>:<key>") to create, change and remove.
- next string
- notes 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.
- 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.
- 413 The request or the media file is too large.
- 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.