app2email API Pricing

Change a drip sequence

PUT https://api.app2email.com/v1/{number}/sequences/{id}
scope: messages:send sandbox: refused MCP: update_sequence

Scope: messages:send. Not with a sandbox key. Send only what changes. status paused holds every contact where they are; active carries on. steps replaces the list: send a step's id to keep it (and its report). Contacts past the last step finish. A new enrol_tag enrols contacts who get it from now on.

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
  • id string required

    The sequence's id.

    e.g. 12

Body application/json required

  • name string
  • status string

    PUT only.

    activepaused
  • stop_on_reply boolean
  • enrol_tag string
  • steps object[]

    1 to 20 steps. In PUT the whole list, in order; a step without id is new, a step left out is deleted.

    10 item fields
    • id integer

      In answers; send it back in PUT to keep a step (and its report).

    • position integer
    • wait_minutes integer

      How long after the previous step (the first step: after enrolling). wait_hours and wait_days may be sent too; they add up. 0 to 90 days.

    • wait_hours integer
    • wait_days integer
    • template_name string required
    • language string
      e.g. en
    • parameters object more keys allowed

      The template's values. {name} in any value is the contact's name.

      6 fields
      • header_text string

        The value of a text header's placeholder.

      • header_media object more keys allowed
        2 fields
        • type string
          imagevideodocument
      • body string[]

        The body's {{1}}, {{2}}... values in order.

      • body_named object any keys

        Values of named placeholders, eg {"first_name": "{name}"}.

      • buttons object[]
        3 item fields
        • index integer
        • text string

          A URL button's suffix.

        • payload string

          A quick reply's payload.

      • Used for {name} when the contact's name is not known (default "there").

    • track_clicks boolean default true

      Each contact gets their own tracked link for every address in the values.

    • report_code string | null

      In answers: the step's report (GET /v1/{number}/broadcasts/{code}), after its first send.

Responses

200 The sequence after the change.
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.
  • 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.
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.