Where marketing templates go: Cloud API or Marketing Messages API
https://api.app2email.com/v1/{number}/marketing The route setting (messages.marketing_route), the route a marketing template takes now, WhatsApp's onboarding status and the account's Cloud API switch. ?refresh=true asks WhatsApp now (otherwise up to 1 hour old).
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Query
- refresh boolean
true: ask WhatsApp now.
Responses
Fields
- success boolean
- request_id string
- marketing object
6 fields
- route string
The number's setting messages.marketing_route.
autocloud_apimm_api - effective_route string
Where a marketing template goes now.
cloud_apimm_api - onboarding_status string
WhatsApp's marketing_messages_onboarding_status (ELIGIBLE, ONBOARDED, ...).
e.g.ONBOARDED - cloud_api_marketing_disabled boolean
The account's disable_marketing_messages_on_cloud_api switch (null: WhatsApp did not give it).
- checked_at string (date-time)
- warning 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.
- 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.