app2email API Pricing

Apply a setup file

POST https://api.app2email.com/v1/{number}/setup/apply
scope: bookings:manage|orders:manage|tickets:manage|submissions:manage sandbox: refused MCP: apply_setup

Scope: the manage scope of each product in the file (bookings:manage for booking, submissions:manage for submit, orders:manage for shop, tickets:manage for tickets). Checks the file again and, with no problem at all, applies it: the records it names are created or changed (mode=replace: the others of the same types removed; needs a check_id). Send {"check_id": n} to apply exactly what a check saw. Before writing, a snapshot is kept: POST /setup/jobs/{job_id}/undo puts it back. Products are switched on only with enable=true; Submit-Info forms published with publish. Any problem: 400 invalid_setup with the problems in error.details, nothing changed.

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

Query

  • mode string

    merge (default): create or change what the file names. replace: also remove, of each record type in the file, what it does not name.

    mergereplace
  • if_unchanged boolean

    true: refuse (409 setup_changed) when the setup changed after the export the file came from.

  • stock string

    Order-and-Pay: ignore (default) leaves stock figures as they are; set writes the file's stock_qty values.

    ignoreset
  • check_id integer

    The check_id of a check without problems: applies exactly that file (no body needed).

  • enable boolean

    true: switch the products of the file on.

  • publish string

    Comma list of Submit-Info form keys to publish to WhatsApp after the apply.

Body application/json | application/jsonl | application/zip

  • jsonl string

    The file as JSON Lines text.

  • lines object[]

    Instead of jsonl: the records as objects.

  • url string

    Instead of jsonl: an https address of the file (.jsonl or .zip).

  • check_id integer

    apply only: the check_id of a check without problems (then no file).

  • mode string
    mergereplace
  • if_unchanged boolean
  • stock string

    Order-and-Pay: ignore (default) leaves stock figures as they are; set writes the file's stock_qty values (a ledger row each).

    ignoreset
  • enable boolean

    apply only: switch the products of the file on.

  • publish string[]

    apply only: Submit-Info form keys to publish to WhatsApp.

Responses

200 Applied.
Fields
  • success boolean required
    e.g. true
  • request_id string required
    e.g. s3tup
  • job_id integer
  • status string

    done | partial (see notes)

  • products string[]
  • mode string
  • plan object any keys

    Per product: counts {create, change, unchanged, remove} and the keys ("<type>:<key>") to create, change and remove.

  • done object any keys
  • notes string[]
  • undo string
202 More than 1,000 records: the work runs in the background. Poll GET /setup/jobs/{job_id} until status is no longer running.
Fields

Errors

api_key_expiredapi_key_number_mismatchapi_key_old_formatapi_key_revokedautomation_not_foundblock_list_busyblock_list_fullblock_users_errorblock_users_failedbsuid_not_supportedcall_permission_requiredconnection_in_useconnection_not_founddisplay_name_not_approvedform_has_submissionsform_not_foundinsufficient_scopeinternal_errorinvalid_api_keyinvalid_authorization_headerinvalid_cursorinvalid_media_linkinvalid_modeinvalid_number_in_urlinvalid_optimization_specinvalid_setupinvalid_template_categoryinvalid_template_componentsinvalid_template_fieldinvalid_template_languageinvalid_template_nameip_not_allowedlist_not_foundmarketing_disabled_on_cloud_apimarketing_per_user_limitmedia_download_errormedia_too_largemedia_upload_errormessaging_limit_restrictedmissing_api_keymissing_setup_filenot_available_on_personal_numbernumber_already_verifiednumber_not_foundoutside_24h_windowparameter_value_invalidpersonal_number_new_chat_limitpersonal_number_not_linkedplan_not_allowedrate_limitedrecipient_identity_changedrecipient_in_experimentrecipient_is_senderrecipient_not_allowedrecipient_stopped_marketingrecipient_unreachableregister_limit_reachedrequest_too_largerequired_parameter_missingsandbox_keyservice_not_livesetup_check_expiredsetup_fetch_failedsetup_job_busysetup_job_not_foundsetup_not_readysetup_product_not_supportedsetup_version_unsupportedtemplate_already_existstemplate_disabledtemplate_format_policytemplate_limit_reachedtemplate_name_reservedtemplate_not_availabletemplate_not_editabletemplate_not_foundtemplate_not_marketingtemplate_parameter_count_mismatchtemplate_parameter_format_mismatchtemplate_parameter_invalidtemplate_pausedtemplate_rejectedtemplate_sample_media_failedtemplate_text_too_longtoo_many_messages_to_recipientunsupported_message_typeusername_account_not_linkedusername_change_limitusername_not_availableusername_not_eligibleusername_takenwhatsapp_account_lockedwhatsapp_account_restrictedwhatsapp_connection_problemwhatsapp_errorwhatsapp_maintenancewhatsapp_number_not_registeredwhatsapp_parameter_errorwhatsapp_payment_issuewhatsapp_permission_missingwhatsapp_rate_limitwhatsapp_unavailable
  • 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.
  • 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.
  • 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.