Approve a held send: it is sent now
https://api.app2email.com/v1/{number}/approvals/{id}/approve Needs the 'messages:send' scope, from a key that is not a sandbox key. The stored request is run as a normal send (the Do Not Call list, the limits and the daily cap are checked again); send in the answer is the answer the original request would have got. Fires approval.resolved. A held send expires 48 hours after it was held.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The approval's id.
e.g.apr_a1b2c3d4e5f6g7h8
Responses
Fields
- success boolean
- request_id string
- approval object
5 fields
- id string
- status string
approvedrejected - resolved_by string
- resolved_at string (date-time)
- send object
Approved only: the answer the original request would have got.
35 fields
- success booleane.g.
true - request_id stringe.g.
kxrkf - message_id string
WhatsApp message id.
e.g.wamid.HBgLNjE0MTIzNDU2NzgVAgARGBJTQU1QTEVfVEVTVF9FVkVOVAA= - status string
accepted: accepted by WhatsApp (delivered/read status: GET /messages/{message_id} or the message.status webhook). partially_accepted / failed: a list where some / none were accepted. queued: background send started (HTTP 202). scheduled: 'send_at' given, sending later (HTTP 202; scheduled_for and the broadcast code). dry_run: a test, nothing sent. pending_approval: held by the key's approval gate (HTTP 202; 'approval' has the id and url).
acceptedpartially_acceptedfailedqueuedscheduleddry_runpending_approval - sandbox boolean
true: a sandbox key simulated the send; nothing went to WhatsApp (message ids start with wamid.SANDBOX.).
- approval object
status pending_approval only.
5 fields
- id stringe.g.
apr_a1b2c3d4e5f6g7h8 - url string
The dashboard page to approve or reject it.
- expires string (date-time)
- recipients integer
- key string
-
status pending_approval only: what was held (recipients, template, text).
- type string
Free-form replies: the message type. Templates: 'template'.
templatetextimagevideodocumentinteractiveaudiostickerlocationcontactsreaction - from stringe.g.
4976659348270 - to stringe.g.
61412345678 - window_closes_at string (date-time)
Free-form replies: when the 24 hour window closes (after the contact's last message).
- scheduled_for string (date-time)
send_at only: when the send starts (UTC).
- scheduled integer
send_at only: how many messages are scheduled.
- template object
- text string
The message text with your values filled in.
- media string
The header media sent, if any.
- conversation_url string
Conversation history page on app2email.com.
- note string
- broadcast object
Several numbers in 'to' only: the broadcast this list is recorded as.
4 fields
- name stringe.g.
October newsletter - code string
- report_url string
The broadcast's report page on app2email.com, with delivered/read counts per number.
- status_url string
GET it (with your API key) for the broadcast's status and the result per number.
- recipients integer
Several numbers in 'to' only: how many different numbers were given.
- accepted integer
Several numbers only: how many messages WhatsApp accepted.
- failed integer
Several numbers only: how many were not sent (see results).
- results object[]
Several numbers only: one entry per number, in the order given.
12 item fields
- to stringe.g.
61412345678 - success boolean
- message_id string
WhatsApp message id, when accepted.
- status string
accepted - text string
This number's message text, when the numbers had different values ('recipients').
- conversation_url string
- error object
Why this number was not sent, eg recipient_opted_out, monthly_limit_reached, recipient_unreachable.
9 fields
-
Stable error code, safe to use in your own logic.
-
What is wrong, in plain words.
-
What to change to make the request work.
- documentation_url string
Where this error is explained.
e.g.https://www.app2email.com/docs/api/errors#template_not_found - is_retriable boolean
true: the same request can work later without a change (limits, caps, trouble on our side or WhatsApp's, a request with the same Idempotency-Key still running).
- retry_after_seconds integer
How long to wait before trying again, when known (also the Retry-After header).
- details object
Extra information, eg the problems found, available templates or languages.
- example_request object
A WhatsApp message in the format of WhatsApp Cloud API (Meta's exact body works unchanged): a template (type 'template', the default, any time), or within 24 hours of the contact's last message a free-form text, image, video, document, audio, sticker, location, contacts, reaction or interactive message. Meta's mark-read body {messaging_product, status: 'read', message_id, typing_indicator?} marks a message as read. Give 'to' or 'recipients' (templates only).
SendTemplateRequest (not expanded) - whatsapp_error object
WhatsApp's (Meta's) own error, when the error came from WhatsApp.
WhatsAppError (not expanded)
-
- would_send boolean
Dry run only.
-
Dry run only: the exact message WhatsApp would get.
- whatsapp_status string
- contacts object[]
WhatsApp's contacts[] of the send answer.
- sent_via string
cloud_apimm_api
- error object
Several numbers only, when none were sent: the first number's error.
Fields: as send.results.error - queued integer
Background send (HTTP 202): how many messages will be sent.
- skipped integer
Background send: how many numbers are skipped (listed in results, eg Do Not Call list).
- dry_run boolean
Dry run only: true.
- would_send integer
Dry run only: how many messages would be sent.
- would_skip integer
Dry run only: how many numbers would be skipped (see results).
- messages_left_this_month integer
Dry run only: messages left this billing month (the plan limit covers outgoing WhatsApp + outgoing emails).
- broadcast_name string
Dry run of a list: the name the broadcast would get.
- whatsapp_status string
WhatsApp's own message_status for paced templates: held_for_quality_assessment = WhatsApp holds it while it checks the template's quality (it may be dropped later, 132015). Not app2email's approval gate.
acceptedheld_for_quality_assessmentpaused - contacts object[]
WhatsApp's contacts[]: the wa_id and business-scoped user_id it resolved.
- sent_via string
MARKETING templates: the path used (cloud_api = /messages, mm_api = the Marketing Messages API). Dry run: the path it would take.
cloud_apimm_api - whatsapp_edge string
Dry run of a template: the WhatsApp endpoint the message would go to.
messagesmarketing_messages
- note string
Errors
- 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.
- 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.