Create or update an authentication template in many languages
https://api.app2email.com/v1/{number}/templates/{name}/authentication Needs 'templates:manage'. Missing languages are created, existing ones updated, in one call. Not for business-scoped user ids (131062). WABA-wide: every number on this WhatsApp Business Account uses the same templates.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The authentication template's name.
e.g.verify_code
Body application/json required
- e.g.
["en_US","es_ES","fr"] - otp_type string
COPY_CODEONE_TAPZERO_TAP - add_security_recommendation boolean
Adds 'For your security, do not share this code.'
-
Adds the expiry footer.
- supported_apps object[]
ONE_TAP and ZERO_TAP: 1 to 5 Android apps.
2 item fields
- package_name string
- signature_hash string
- zero_tap_terms_accepted boolean
ZERO_TAP: must be true.
- components object[]
Instead of the fields above: BODY, FOOTER, BUTTONS in WhatsApp's format.
Responses
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.
- 422 The request is understood but cannot be sent (template parameters, media, text, recipient, or a WhatsApp rule such as the 24 hour window).
- 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.