Create a template and submit it for approval
https://api.app2email.com/v1/{number}/templates Needs the 'templates:manage' scope. The template goes to WhatsApp for review (minutes to a day). template.status_changed tells the result. Every Meta field is passed on (TTL, link tracking, max price, Template Library). 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
Body application/json required
-
Lowercase letters, digits and underscores.
e.g.order_update - e.g.
en -
MARKETINGUTILITYAUTHENTICATIONe.g.UTILITY - components object[]
WhatsApp's components: BODY (text), HEADER, FOOTER, BUTTONS. Required unless library_template_name is given.
e.g.[{"type":"BODY","text":"Hi {{1}}, your order {{2}} has shipped.","example":{"bo… - parameter_format string
NAMED ({{first_name}}) or POSITIONAL ({{1}}) placeholders.
NAMEDPOSITIONAL - allow_category_change boolean
Passed on; Meta ignores it since 9 Apr 2025 (it sets the category itself).
- message_send_ttl_seconds integer
How long WhatsApp tries to deliver (Meta's ranges per category).
- cta_url_link_tracking_opted_out boolean
true: no click tracking on URL buttons.
- is_primary_device_delivery_only boolean
- sub_category stringe.g.
ORDER_STATUS - display_format stringe.g.
ORDER_DETAILS -
Marketing creative options, as Meta takes them.
- send_type string
Marketing Messages API templates.
campaigndirect - optimization_spec object
Marketing max price (Meta: 'max price'). Needs the WhatsApp account enrolled in Meta's max price feature (Marketing Messages API). Both fields null: back to rate card pricing. Replaces bid_spec (not accepted since 31 Jul 2026).
3 fields
-
Most WhatsApp may charge per 1,000 deliveries, in the smallest unit of the account's currency (5000 = USD 0.05 a message).
e.g.5000 -
LOWEST_COST_WITH_BID_CAP -
Country (ISO 3166-1 alpha-2) -> multiplier (above 0, at most 10), up to 240. Replaces the whole map; {} removes it.
e.g.{"IN":1.2,"MX":0.8}
-
- library_template_name string
Create from the Template Library (GET /template-library); then no components.
e.g.delivery_update_1 - e.g.
{"add_contact_number":true}
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.
- 413 The request or the media file is too large.
- 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.