One drip sequence with its steps and report
https://api.app2email.com/v1/{number}/sequences/{id} Scope: messages:read. The steps, the counts, and per step: posted, sent, delivered, read, failed and clicked, with a link to the step's own report.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The sequence's id.
e.g.12
Responses
Fields
- e.g.
true -
12 fields
- id integer
- name string
- status string
activepausedarchived - stop_on_reply boolean
Stop a contact's sequence when they write back (default true). Opting out always stops it.
- enrol_tag string
Contacts who get this tag from now on are enrolled automatically ('' = off). A contact is enrolled this way once.
- enrol_tag_since string (date-time) | null
- created_by string
- created_at string (date-time)
- updated_at string (date-time)
- steps object[]
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
- language stringe.g.
en -
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
- body array
The body's {{1}}, {{2}}... values in order.
- body_named object
Values of named placeholders, eg {"first_name": "{name}"}.
- name_fallback string
Used for {name} when the contact's name is not known (default "there").
-
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.
- report object[]
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.
- 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.