One setup job
https://api.app2email.com/v1/{number}/setup/jobs/{id} 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). One check, apply or undo: its plan, problems and result. include=content and / or include=snapshot add the file it checked or applied and the snapshot taken before an apply.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The job id (job_id of an apply, check_id of a check).
e.g.42
Query
- include string
content, snapshot (comma list).
Responses
Fields
- e.g.
true - e.g.
s3tup - job object
16 fields
- id integer
- kind string
check | apply | undo
- products string[]
- mode string
- status string
check: ok | problems | applied. apply / undo: running | done | partial | failed | undone.
- problems object[]
- check_id integer | null
- undo_of integer | null
- created_by string
- created string (date-time)
- finished string (date-time) | null
- has_snapshot boolean
- snapshot string
- content 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.
- 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.