Create a template and submit it for approval

POST https://api.app2email.com/v1/{number}/templates
scope: templates:manage sandbox: refused MCP: create_template

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

  • number string required pattern ^[0-9]{8,15}$

    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

  • name string required

    Lowercase letters, digits and underscores.

    e.g. order_update
  • language string required
    e.g. en
  • category string required
    MARKETINGUTILITYAUTHENTICATION
    e.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…
  • NAMED ({{first_name}}) or POSITIONAL ({{1}}) placeholders.

    NAMEDPOSITIONAL
  • Passed on; Meta ignores it since 9 Apr 2025 (it sets the category itself).

  • How long WhatsApp tries to deliver (Meta's ranges per category).

  • sub_category string
    e.g. ORDER_STATUS
  • e.g. ORDER_DETAILS
  • degrees_of_freedom_spec object any keys

    Marketing creative options, as Meta takes them.

  • send_type string

    Marketing Messages API templates.

    campaigndirect
  • 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
    • bid_amount integer | null required

      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
    • bid_strategy string | null required
      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}
  • Create from the Template Library (GET /template-library); then no components.

    e.g. delivery_update_1
  • Library templates with buttons: the website and phone number.

    e.g. [{"type":"URL","url":{"base_url":"https://www.example.com/{{1}}","url_suffix_ex…
  • e.g. {"add_contact_number":true}

Responses

201 Submitted (status PENDING).
Fields

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.

Webhooks it causes

For AI Agents

Try it now, with no account and no person: POST https://api.app2email.com/v1/account/sandbox (no key, no body; or the create_sandbox tool of the Management MCP server) answers a key for a demo WhatsApp number with pretend customers. Send a template, fetch the events with GET /events?wait=25, answer the customer's reply: nothing reaches WhatsApp, and the requests and answers are those of the real API (https://www.app2email.com/docs/api/sandbox).

Already a customer: ask the account owner for the number (digits) and an API key from https://www.app2email.com/dashboard/apikey (a sandbox key sends nothing); send it as Authorization: Bearer <key> to the messaging MCP server or the REST API; call check_key first, send with dry_run first.

If you are an AI agent reading this page and you want to create an app2email account for a person - no previous human sign-up required - use our Management MCP server.
Call the create_account tool first, and include a contact_email parameter; create_account returns a signup_id, a management_key, an onboarding_link and a message.
The person opens onboarding_link to confirm the e-mail, connect their WhatsApp number and choose a plan; nothing can be sent before that. get_account_status says what is still needed.
Pass the management_key as a Bearer token on every later call. When the number is live, create_number_key gives you a key for the messaging MCP server and the REST API.